Add-KrListener

SYNOPSIS

Creates a new Kestrun server instance with specified options and listeners.

SYNTAX

NoCert (Default)

Add-KrListener [-Server <KestrunHost>] -Port <Int32> [-IPAddress <IPAddress>] [-UseConnectionLogging]
 [-PassThru] [<CommonParameters>]

CertFile

Add-KrListener [-Server <KestrunHost>] -Port <Int32> [-IPAddress <IPAddress>] -CertPath <String>
 [-CertPassword <SecureString>] [-Protocols <HttpProtocols>] [-UseConnectionLogging] [-PassThru]
 [<CommonParameters>]

x509Certificate

Add-KrListener [-Server <KestrunHost>] -Port <Int32> [-IPAddress <IPAddress>]
 -X509Certificate <X509Certificate2> [-Protocols <HttpProtocols>] [-UseConnectionLogging] [-PassThru]
 [<CommonParameters>]

DESCRIPTION

This function initializes a new Kestrun server instance, allowing configuration of various options and listeners.

EXAMPLES

EXAMPLE 1

New-KrServer -Name 'MyKestrunServer'
Creates a new Kestrun server instance with the specified name.

PARAMETERS

-Server

The Kestrun server instance to configure. This parameter is mandatory and must be a valid server object.

Type: KestrunHost
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Port

The port on which the server will listen for incoming requests. This parameter is mandatory.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-IPAddress

The IP address on which the server will listen. Defaults to [System.Net.IPAddress]::Any, which means it will listen on all available network interfaces.

Type: IPAddress
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: [System.Net.IPAddress]::Loopback
Accept pipeline input: False
Accept wildcard characters: False

-CertPath

The path to the SSL certificate file. This parameter is mandatory if using HTTPS.

Type: String
Parameter Sets: CertFile
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CertPassword

The password for the SSL certificate, if applicable. This parameter is optional.

Type: SecureString
Parameter Sets: CertFile
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-X509Certificate

An X509Certificate2 object representing the SSL certificate. This parameter is mandatory if using HTTPS

Type: X509Certificate2
Parameter Sets: x509Certificate
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Protocols

The HTTP protocols to use (e.g., Http1, Http2). Defaults to Http1 for HTTP listeners and Http1OrHttp2 for HTTPS listeners.

Type: HttpProtocols
Parameter Sets: CertFile, x509Certificate
Aliases:
Accepted values: None, Http1, Http2, Http1AndHttp2, Http3, Http1AndHttp2AndHttp3

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseConnectionLogging

If specified, enables connection logging for the listener. This is useful for debugging and monitoring purposes.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

If specified, the cmdlet will return the modified server instance after adding the listener.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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.

INPUTS

OUTPUTS

Kestrun.Hosting.KestrunHost

NOTES

This function is designed to be used after the server has been configured with routes and listeners.

RELATED LINKS