< Back

Export-TlsSessionTicketKey

Wed Jan 30, 2019 6:04 pm

NAME Export-TlsSessionTicketKey



SYNOPSIS

Exports a TLS session ticket key.





SYNTAX

Export-TlsSessionTicketKey [-Password] <SecureString> [[-Path] <String>] [-ServiceAccountName] <NTAccount> [-Confirm] [-WhatIf] [<CommonParameters>]





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 TLS Session Resumption without Server-Side State mechanism. For more information, see New-TlsSessionTicketKey

or type Get-Help New-TlsSessionTicketKey.





PARAMETERS

-Password <SecureString>

Specifies the password, as a secure string, for the key.



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.



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. Only System,

LocalService, NetworkService, and SID of virtual accounts are supported.



Required? true

Position? 3

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.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, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS









OUTPUTS









Example 1: Export a TLS session ticket key



PS C:\\>$Password = Read-Host -AsSecureString

PS C:\\> Export-TlsSessionTicketKey -Password $Password -Path "C:\\KeyConfig\\TlsSessionTicketKey.config" -ServiceAccountName "NetworkService"



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







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=294409

Enable-TlsSessionTicketKey

New-TlsSessionTicketKey

Disable-TlsSessionTicketKey