Export-RmsTPD

Module:
adrmsadmin
Exports a TPD in AD RMS.

Syntax 

Export-RmsTPD
      [-SavedFile] <String[]>
      [-Password] <SecureString>
      [-V1Compatible]
      [-Force]
      [-Path] <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Export-RmsTPD cmdlet exports a trusted publishing domain (TPD) in Active Directory Rights Management Services (AD RMS) to a file.

To perform the export, set the SavedFilePath parameter to the export file path, and then set the Path parameter to the AD RMS provider path <PSDrive>:\TrustPolicy\TrustedPublishingDomain\<TPD_ID> where <PSDrive> is the provider drive ID and <TPD_ID> is the ID of the TPD that you want to export.

Examples

Example 1: Export a TPD by ID 

PS C:\> Export-RmsTPD -Path ".\100" -SavedFile "c:\temp\test.xml"

This command exports the TPD with the ID of 100 to the file C:\temp\test.xml. Because the Password parameter is not specified, the command prompts for the password.

Example 2: Read a password and use it to export a TPD 

PS C:\> $pswd = Read-Host -AsSecureString
PS C:\> Export-RmsTPD -Path "100" -SavedFile "c:\temp\test.xml" -Password $pswd

The first command prompts for a password and saves it in the variable $pswd. The variable is then passed to the Export-RmsTPD command as the Password parameter. Note that the Export-RmsTPD command prompts for a confirmation password that must match the password stored in the $pswd variable.

Example 3: Export a TPD without prompting for the password 

PS C:\> $pswd=Read-Host -AsSecureString
PS C:\> Export-RmsTPD -Path "100" -SavedFile "c:\temp\test.xml" -Password $pswd -Force

The first command prompts for a password and saves it in the variable $pswd. The variable is then passed to the Export-RmsTPD command as the Password parameter. Because the Force parameter is specified, the Export-RmsTPD command does not prompt for a confirmation password.

Required Parameters

-Password

Specifies a password as a SecureString object. To create a SecureString object that contains a password, use the Read-Host cmdlet and specify the AsSecureString parameter.

Type: SecureString
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Path

Specifies a provider drive and path or relative path on the current drive. Use a dot (.) to specify the current location. This parameter does not accept wildcards and has no default value.

Type: String[]
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SavedFile

Specifies the full path and filename of the file that receives the exported content.

Type: String[]
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

Overrides restrictions that prevent the command from succeeding if the restrictions do not compromise security. For example, Force overrides the read-only attribute or creates directories to complete a file path, but it does not attempt to change file permissions.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-V1Compatible

Allows the trusted publishing domain to be imported to Windows Rights Management Services (RMS) 1.0.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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
Accept pipeline input: False
Accept wildcard characters: False