Import-RmsTPD
Import-RmsTPD
Imports a trusted publishing domain (TPD) from a file in Active Directory Rights Management Services (AD RMS).
Syntax
Import-RmsTPD [-DisplayName] <String> [-SourceFile] <String> [-Password] <SecureString> [-Force] [-PassThru] [-Path] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
Detailed Description
The Import-RmsTPD cmdlet imports a trusted publishing domain 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 subpath “<PSDrive>:\TrustPolicy\TrustedPublishingDomain” where <PSDrive> is the provider drive ID.
Parameters
-DisplayName <String>
Specifies the name that will be used to identify the domain being imported.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Position? |
2 |
-SourceFile <String>
Specifies the path to the file that contains the domain information to import.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Position? |
3 |
-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 |
-Force <SwitchParameter>
Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Position? |
named |
-PassThru <SwitchParameter>
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
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 |
Microsoft.RightsManagementServices.PowerShell.TrustedPublishingDomainImportedItem. Returns the imported trusted publishing domain when the PassThru parameter is specified. By default, this cmdlet does not generate any output. |
Notes
Examples
EXAMPLE 1
C:\PS>Import-TPD -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. Note that because the Password parameter was not used, the Import-TPD cmdlet prompts for the domain password.
EXAMPLE 2
C:\PS>$pswd = Read-Host -Prompt "Password:" -AsSecureString
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.