Export-RmsTPD

Export-RmsTPD

Exports a TPD in AD RMS.

Syntax

Parameter Set: Default
Export-RmsTPD [-Path] <String[]> [-SavedFile] <String[]> [-Password] <SecureString> [-Force] [-V1Compatible] [-Confirm] [-WhatIf] [ <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 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.

Parameters

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

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


Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Path<String[]>

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.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SavedFile<String[]>

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


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-V1Compatible

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

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

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Export a TPD by ID

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.


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

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

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.


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

Example 3: Export a TPD without prompting for the password

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.


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

Related topics

Community Additions

ADD
Show: