Edit

Share via

New-TlsSessionTicketKey

Module:
TLS Module

Creates a TLS session ticket key configuration file.

Syntax

Default (Default) 

New-TlsSessionTicketKey
    [[-Path] <String>]
    [-Password] <SecureString>
    [<CommonParameters>]

Description

The New-TlsSessionTicketKey cmdlet creates a password protected Transport Layer Security (TLS) Session Ticket key configuration file.

TLS creates a session ticket by using the TLS Session Resumption without Server-Side State mechanism. This mechanism helps to improve the performance of TLS. The TLS server uses this mechanism to create a key to encrypt a session ticket. The client can later use the encrypted session ticket to resume communication with the TLS server. Otherwise, the client must restart the communication by acquiring of new session ticket. For more information, see RFC 5077, Transport Layer Security (TLS) Session Resumption without Server-Side State.

Examples

Example 1: Create a TLS session ticket key

$Password = Read-Host -AsSecureString
New-TlsSessionTicketKey -Password $Password -Path 'C:\KeyConfig\TlsSessionTicketKey.config'

The first command prompts the user to enter a password by using the Read-Host cmdlet. The command masks the password that the user types at the prompt. For more information, type Get-Help Read-Host. The command stores the password in the $Password variable.

The second command creates the session ticket key configuration file which can be used to enable the TLS session ticket for a service account. The command specifies the path for the output configuration file on the TLS server, and specifies that the TLS session use the password stored in $Password to access the configuration file.

Parameters

-Password

Specifies the password, as a secure string, for the configuration file of the TLS server.

Parameter properties

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

Parameter sets

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

-Path

Specifies the path of the configuration file for the TLS server. The cmdlet outputs the generated configuration file to this path.

Parameter properties

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

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
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.