Export-RmsTPD

Export-RmsTPD

Exports a trusted publishing domain (TPD) in Active Directory Rights Management Services (AD RMS) to a file.

Syntax

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

Detailed 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 subpath “<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.

Parameters

-SavedFile <String[]>

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

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	2

-Password <SecureString>

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.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	3

-V1Compatible <SwitchParameter>

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

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	named

-Force <SwitchParameter>

Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. For example, Force will override the read-only attribute or create directories to complete a file path, but it will not attempt to change file permissions.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	named

-Path <String[]>

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

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	1

-WhatIf <SwitchParameter>

Describes what would happen if you executed the command without executing the command.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-CommonParameter

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see About Common Parameter

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Input Type	.
Return Type	.

Notes

Examples

EXAMPLE 1

C:\PS>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 used, the command prompts for the password.

EXAMPLE 2

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

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

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

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 was used, the Export-RmsTPD command does not prompt for a confirmation password.

See Also

Reference

Import-RmsTPD
Export-RmsTUD
Import-RmsTUD
Read-Host
com/fwlink/?LinkId=136806