Import-RmsTPD
Imports a TPD from a file in AD RMS.
Syntax
Import-RmsTPD
[-DisplayName] <String>
[-SourceFile] <String>
[-Password] <SecureString>
[-Force]
[-PassThru]
[-Path] <String[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Import-RmsTPD cmdlet imports a trusted publishing domain (TPD) from a file in Active Directory Rights Management Services (AD RMS).
To perform the import, specify the DisplayName, SourceFile and Password parameters, and then set the Path parameter to the AD RMS provider drive path <PSDrive>:\TrustPolicy\TrustedPublishingDomain
where <PSDrive>
is the provider drive ID.
Examples
Example 1: Import a TPD and assign it a name
PS C:\> Import-RmsTPD -Path "." -DisplayName "Fabrikam" -SourceFile "c:\transfer\fabrikam.xml"
This command imports the TPD information stored in the specified file and assigns the name Fabrikam to the TPD. Because the Password parameter is not specified, the Import-RmsTPD cmdlet prompts for the domain password.
Example 2: Read a password and use it to import a TPD
PS C:\> $pswd = Read-Host -Prompt "Password:" -AsSecureString
PS C:\> Import-RmsTPD -Path "." -DisplayName "Fabrikam" -SourceFile "c:\transfer\fabrikam.xml" -Password $pswd
This command uses the Read-Host cmdlet to prompt the user for a password and then stores the password in a variable that is passed to the Import-RmsTPD cmdlet.
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 |
-DisplayName
Specifies the name that will be used to identify the domain being imported.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Force
Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PassThru
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-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 |
Required: | True |
Accept pipeline input: | True |
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 |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceFile
Specifies the path to the file that contains the domain information to import.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
Outputs
Microsoft.RightsManagementServices.PowerShell.TrustedPublishingDomainImportedItem