Edit

Export-TlsSessionTicketKey

  • Reference
Module:
TLS

Exports a TLS session ticket key.

Syntax

Export-TlsSessionTicketKey
      [-ServiceAccountName] <NTAccount>
      [[-Path] <String>]
      [-Password] <SecureString>
      [-WhatIf]
      [-Confirm]
      [<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.

Examples

Example 1: Export a TLS session ticket key

$Password = Read-Host -AsSecureString
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.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Password

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

Type:SecureString
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

Specifies the path of the configuration file for the TLS server.

Type:String
Aliases:FullName
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ServiceAccountName

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.

Type:NTAccount
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False