Export-TlsSessionTicketKey
Export-TlsSessionTicketKey
Exports a TLS session ticket key.
Syntax
Parameter Set: Default
Export-TlsSessionTicketKey [-Password] <SecureString> [[-Path] <String> ] [-ServiceAccountName] <NTAccount> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Export-TlsSessionTicketKey cmdlet exports the administrator managed Transport Layer Security (TLS) session ticket key for a service account.
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 key.
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.
Aliases |
FullName |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServiceAccountName<NTAccount>
Specifies the name of a service account. The cmdlet exports the configuration of the TLS session ticket key for the service account.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
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: Export 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 exports the session ticket key for the service account named Networkservice from the configuration file on the TLS server. The command specifies the path for the 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:\> Export-TlsSessionTicketKey -Path "C:\keyconfig\tlssessionticketKey.config" -Password $Password -ServiceAccountName "Networkservice"