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
 

Export-TlsSessionTicketKey

Export-TlsSessionTicketKey

microsoft.windowsauthenticationprotocols.commands.dll

Synopsis

Exports a TLS session ticket key.

Syntax

Export-TlsSessionTicketKey [-Password] [-Path] [-ServiceAccountName] [-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 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.

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. Only System, LocalService, NetworkService, and SID of virtual accounts are supported.

Aliases

none

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.

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Export 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 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 -Password $Password -Path "C:\KeyConfig\TlsSessionTicketKey.config" -ServiceAccountName "NetworkService"

Online Version
Enable-TlsSessionTicketKey
New-TlsSessionTicketKey
Disable-TlsSessionTicketKey