New-TlsSessionTicketKey
New-TlsSessionTicketKey
Creates a TLS session ticket key configuration file.
Syntax
Parameter Set: Default
New-TlsSessionTicketKey [-Password] <SecureString> [[-Path] <String> ] [ <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 Transport Layer Security (TLS) Session Resumption without Server-Side State mechanism [RFC 5077]. 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 |
<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.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Create a TLS session ticket key
This example exports the key for a TLS session ticket for a service account.
The first command prompts the user to enter a password. The command masks the password that the user types at the prompt. The command stores the password in the $Password variable
The second command creates the session ticket key configuration file for the service account named Networkservice. 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 -Path "C:\keyconfig\tlssessionticketKey.config" -Password $Password