Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NetIPHttpsConfiguration

Set-NetIPHttpsConfiguration

msft_netiphttpsconfiguration.cdxml

Synopsis

Modifies an IP-HTTPS configuration.

Syntax

Set-NetIPHttpsConfiguration [-AsJob] [-AuthMode] [-CimSession] [-PassThru] [-PolicyStore] [-Profile] [-ProfileActivated] [-ServerURL] [-State] [-StrongCRLRequired] [-ThrottleLimit] [-Type] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetIPHttpsConfiguration [-AsJob] [-AuthMode] [-CimSession] [-PassThru] [-ServerURL] [-State] [-StrongCRLRequired] [-ThrottleLimit] [-Type] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetIPHttpsConfiguration [-AsJob] [-AuthMode] [-CimSession] [-GPOSession] [-PassThru] [-Profile] [-ProfileActivated] [-ServerURL] [-State] [-StrongCRLRequired] [-ThrottleLimit] [-Type] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NetIPHttpsConfiguration cmdlet modifies an IP-HTTPS configuration.

You can specify the IP-HTTPS configuration profile to modify either by using a configuration object retrieved by the Get-NetIPHttpsConfiguration cmdlet or by specifying the profile name.

Parameters

-AsJob <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AuthMode <AuthMode>

Specifies the authentication mode. The acceptable values for this parameter are:  -- None: Performs no client authentication during the SSL handshake. This is the default value. -- Certificates: Uses client certificates to authenticate clients. This authentication mode applies only to a server interface on a computer running Windows Server® 2012.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-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

-GPOSession <String>

Specifies the Group Policy session to which to store the configuration information. You can use this parameter with the NetGPO cmdlets to aggregate multiple operations performed on a Group Policy Object (GPO). You cannot use this parameter with the PolicyStore parameter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the object which contains the IP-HTTPS configuration to modify.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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 that contains the IP-HTTPS configuration profile to set. The acceptable values for this parameter are:  -- ActiveStore -- PersistentStore -- GPO To set the configuration profile of a GPO, specify the GPO name using the following format: Domain\GPOName You cannot use this parameter with the GPOSession parameter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Profile <String[]>

Specifies the name of the profile to modify. This parameter is only allowed when the store is a GPO.

Aliases

IPHttpsProfile

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ProfileActivated <Boolean[]>

Filters the objects to modify.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ServerURL <String>

Specifies the URL for the server. If the profile is a client profile, Windows attempts to connect to the server URL. If the profile is a server profile, then this is the URL to which the server listens.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-State <State>

Specifies the state behavior of IP-HTTPS. The acceptable values for this parameter are:  -- Default: ---- For a server interface, IP-HTTPS is always configured. ---- For a client interface, IP-HTTPS is configured on demand based on the other connectivity options available. Client interfaces are created with this setting by default. -- Enabled: IP-HTTPS is always configured, for both server interfaces and client interfaces. Server interfaces are created with this setting by default. -- Disabled: Disables the IP-HTTPS interface. -- OutsideEnabled: IP-HTTPs is configured on demand whenever the computer is outside of the corporate network.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-StrongCRLRequired <Boolean>

Determines if a strong certificate revocation list (CRL) check is required before connection. The default value is False.

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

-Type <Type>

Specifies if IP-HTTPS should start in server mode or client mode. The parameter value set to server mode is only allowed on Windows Server 2012.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIpHTTPsConfiguration

Notes

None

Examples

Example 1: Set the server URL of the profile

This command modifies the profile named Redmond in the GPO named TestGPO, modifying the server URL.

PS C:\>Set-NetIPHttpsConfiguration -Profile Redmond -ServerURL https://da.com:443/IPHTTPs -PolicyStore Domain\TestGPO

Example 2: Set the server URL using IP-HTTPS configuration object

This command gets the IP-HTTPS configuration profile named Redmond in the GPO named TestGPO using the Get-NetIPHttpsConfiguration cmdlet, and then provides the output object as input to this cmdlet using the pipeline operator.

PS C:\>Get-NetIPHttpsConfiguration -Profile Redmond -PolicyStore Domain\TestGPO | Set-NetIPHttpsConfiguration -ServerURL https://da.com:443/IPHTTPs

Online Version
Get-NetIPHttpsConfiguration
New-NetIPHttpsConfiguration
Rename-NetIPHttpsConfiguration
Remove-NetIPHttpsConfiguration
Reset-NetIPHttpsConfiguration