Set-NetIPHttpsConfiguration

Set-NetIPHttpsConfiguration

Modifies an IP-HTTPS configuration.

Syntax

Parameter Set: ByPolicyStore
Set-NetIPHttpsConfiguration [-AsJob] [-AuthMode <AuthMode> ] [-CimSession <CimSession[]> ] [-PassThru] [-PolicyStore <String> ] [-Profile <String[]> ] [-ProfileActivated <Boolean[]> ] [-ServerURL <String> ] [-State <State> ] [-StrongCRLRequired <Boolean> ] [-ThrottleLimit <Int32> ] [-Type <Type> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByGpoSession
Set-NetIPHttpsConfiguration [-AsJob] [-AuthMode <AuthMode> ] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-PassThru] [-Profile <String[]> ] [-ProfileActivated <Boolean[]> ] [-ServerURL <String> ] [-State <State> ] [-StrongCRLRequired <Boolean> ] [-ThrottleLimit <Int32> ] [-Type <Type> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-NetIPHttpsConfiguration -InputObject <CimInstance[]> [-AsJob] [-AuthMode <AuthMode> ] [-CimSession <CimSession[]> ] [-PassThru] [-ServerURL <String> ] [-State <State> ] [-StrongCRLRequired <Boolean> ] [-ThrottleLimit <Int32> ] [-Type <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

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

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

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

-InputObject<CimInstance[]>

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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

-Profile<String[]>

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

-ProfileActivated<Boolean[]>

Filters the objects to modify.

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

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

-StrongCRLRequired<Boolean>

Determines if a strong certificate revocation list (CRL) check is required before connection.
The default value is 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.

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

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

• None

  This cmdlet accepts no input objects.

Outputs

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

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

  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.
  When the Passthru parameter is specified, this cmdlet outputs a modified IP-HTTPS configuration object.

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

Related topics

Get-NetIPHttpsConfiguration

New-NetIPHttpsConfiguration

Rename-NetIPHttpsConfiguration

Remove-NetIPHttpsConfiguration

Reset-NetIPHttpsConfiguration