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
 

New-TlsSessionTicketKey

New-TlsSessionTicketKey

microsoft.windowsauthenticationprotocols.commands.dll

Synopsis

Creates a TLS session ticket key configuration file.

Syntax

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

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

Parameters

-Password <SecureString>

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

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

True (ByValue, ByPropertyName)

Accept wildcard characters?

false

-Path <String>

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

Aliases

FullName

Required?

false

Position

2

Default value

none

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Create a TLS session ticket key

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.

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

Online Version
Enable-TlsSessionTicketKey
Export-TlsSessionTicketKey
Disable-TlsSessionTicketKey