Edit

Share via


New-NetIPHttpsConfiguration

Creates an IP-HTTPS configuration.

Syntax

ByPolicyStore (Default)

New-NetIPHttpsConfiguration
    [-PolicyStore] <String>
    -ServerURL <String>
    [-Profile <String>]
    [-Type <Type>]
    [-State <State>]
    [-AuthMode <AuthMode>]
    [-StrongCRLRequired <Boolean>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByGpoSession

New-NetIPHttpsConfiguration
    [-GPOSession] <String>
    -ServerURL <String>
    [-Profile <String>]
    [-Type <Type>]
    [-State <State>]
    [-AuthMode <AuthMode>]
    [-StrongCRLRequired <Boolean>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-NetIPHttpsConfiguration cmdlet creates an IP-HTTPS configuration.

This cmdlet can create IP-HTTPS configurations on the ActiveStore, PersistentStore, or Group Policy Objects (GPOs).

Examples

Example 1: Create an IP-HTTPS configuration

PS C:\>New-NetIPHttpsConfiguration -Profile "Redmond" -ServerURL "https://contoso.com:443/IPHTTPs" -PolicyStore "Domain\TestGPO"

This command creates an IP-HTTPS configuration named Redmond with the specified server URL https://contoso.com:443/IPHTTPs in the GPO named TestGPO.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AuthMode

Specifies the authentication mode of the IP-HTTPS configuration.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 or Windows Server 2016.

Parameter properties

Type:AuthMode
Default value:None
Accepted values:None, Certificates
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GPOSession

Specifies the Group Policy session in which to store the configuration information.

You can use this parameter with the NetGPO cmdlets to aggregate multiple operations performed on a GPO.

You cannot use this parameter with the PolicyStore parameter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByGpoSession
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PolicyStore

Specifies the policy store to which to add the configuration profile. The acceptable values for this parameter are:

  • ActiveStore
  • PersistentStore
  • GPO

To add the configuration profile to a GPO, specify the GPO name using the following format: Domain\GPOName

You cannot use this parameter with the GPOSession parameter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByPolicyStore
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Profile

Specifies the name by which to identify the IP-HTTPS configuration profile. This option is only available if the store is a GPO.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:IPHttpsProfile

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerURL

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

Specify the server URL using the following format: https://myserver/IPHTTPS

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:State
Default value:None
Accepted values:Default, Enabled, Disabled, OutsideEnabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StrongCRLRequired

Indicates if a strong certificate revocation list (CRL) check is required before a connection.

By default, the value of this parameter is $False.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ThrottleLimit

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Type

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

Parameter properties

Type:Type
Default value:None
Accepted values:Client, Server
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

This cmdlet accepts no input objects.

Outputs

Object

This cmdlet returns an object.