Clear-ADClaimTransformLink
Clear-ADClaimTransformLink
Removes a claims transformation from being applied to one or more cross-forest trust relationships in Active Directory.
Syntax
Parameter Set: Default
Clear-ADClaimTransformLink [-Identity] <ADTrust> [-AuthType <ADAuthType> ] [-Credential <PSCredential> ] [-PassThru] [-Policy <ADClaimTransformPolicy> ] [-Server <String> ] [-TrustRole <ADTrustRole> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Clear-ADClaimTransformLink cmdlet removes a claims transformation from being applied to one or more cross-forest trust relationships in Active Directory.
Parameters
-AuthType<ADAuthType>
Specifies the authentication method to use. Possible values for this parameter include:
Negotiate or 0
Basic or 1
The default authentication method is Negotiate.
A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.
The following example shows how to set this parameter to Basic.
-AuthType Basic
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
Microsoft.ActiveDirectory.Management.AuthType.Negotiate |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default.
To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.
You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials.
$AdminCredentials = Get-Credential "Domain01\User01"
The following shows how to set the Credential parameter to these credentials.
-Credential $AdminCredentials
If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Identity<ADTrust>
Specifies an Active Directory trust object by providing one of the following values. The identifier in parentheses is the LDAP display name for the attribute.
Distinguished Name
Example: CN=fabikam.com,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
This parameter can also get this object through the pipeline or you can set this parameter to an object instance.
This example shows how to set this parameter to a group object instance named "ADTrustInstance".
-Identity $ADTrustInstance
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-PassThru
Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Policy<ADClaimTransformPolicy>
Removes the specified claim transformation policy from being applied to the trust relationship.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Server<String>
Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.
Domain name values:
Fully qualified domain name
Examples: corp.contoso.com
NetBIOS name
Example: CORP
Directory server values:
Fully qualified directory server name
Example: corp-DC12.corp.contoso.com
NetBIOS name
Example: corp-DC12
Fully qualified directory server name and port
Example: corp-DC12.corp.contoso.com:3268
The default value for the Server parameter is determined by one of the following methods in the order that they are listed:
-By using Server value from objects passed through the pipeline.
-By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive.
-By using the domain of the computer running Windows PowerShell.
The following example shows how to specify a full qualified domain name as the parameter value.
-Server "corp.contoso.com"
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TrustRole<ADTrustRole>
Specifies the role of the current forest in the trust relationship specified by the Identity parameter. The allowable values for this parameter are as follows:
- Trusted (specify this value if the current forest is the trusted forest)
- Trusting (specify this value if the current forest is the trusting forest)
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.ActiveDirectory.Management.ADTrust
An account object (Microsoft.ActiveDirectory.Management.ADTrust) is received by the Identity parameter.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Remove the policy named 'DenyAllPolicy' from the 'corp.contoso.com' trust.
C:\PS>Clear-ADClaimTransformLink "corp.contoso.com" -Policy DenyAllPolicy
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
Remove any policies that are applied to where this forest acts as the trusted forest in the "corp.contoso.com" trust. Effectively, this cmdlet removes any policies that are applied to claims flowing out of this forest towards it trust partner.
C:\PS>Clear-ADClaimTransformLink "corp.contoso.com" -TrustRole Trusted
-------------------------- EXAMPLE 3 --------------------------
Description
-----------
Remove "DenyAllPolicy" that is applied to where this forest acts as the trusted domain in the "corp.contoso.com" trust. Effectively, this cmdlet removes "DenyAllPolicy" from applying to claims coming into this from its trust partner.
C:\PS>Clear-ADClaimTransformLink "corp.contoso.com" -Policy DenyAllPolicy -TrustRole Trusting