< Back
Disable-ADOptionalFeature
Post
NAME Disable-ADOptionalFeature
SYNOPSIS
Disables an Active Directory optional feature.
SYNTAX
Disable-ADOptionalFeature [-Identity] <ADOptionalFeature> [-Scope] {Unknown | ForestOrConfigurationSet | Domain}
[-Target] <ADEntity> [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-PassThru] [-Server <String>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Disable-ADOptionalFeature disables an Active Directory optional feature that is associated with a particular
Domain Mode or Forest Mode.
The Identity parameter specifies the Active Directory optional feature that you want to disable. You can identify
an optional feature by its distinguished name (DN), feature GUID, or object GUID. You can also set the parameter
to an optional feature object variable, such as $<localOptionalFeatureObject> or you can pass an optional feature
object through the pipeline to the Identity parameter. For example, you can use the Get-ADOptionalFeature cmdlet
to retrieve an optional feature object and then pass the object through the pipeline to the
Disable-ADOptionalFeature cmdlet.
The Scope parameter specifies the scope at which the optional feature is disabled. Possible values for this
parameter are Domain and Forest.
The Target parameter specifies the domain or forest on which the optional feature is disabled. You can identify
the domain or forest by its fully-qualified domain name (FQDN), NetBIOS name, or the distinguished name (DN) of
the domain naming context (domain NC).
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
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADOptionalFeature>
Specifies an Active Directory optional feature object by providing one of the following values. The identifier
in parentheses is the LDAP display name for the attribute.
Fully qualified domain name
Example: corp.contoso.com
Feature GUID (featureGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
Object GUID (objectGUID)
Example: 482ab21c-823e-401e-879a-ac7383d64eb9
The cmdlet searches the default naming context or partition to find the object. If two or more objects are
found, the cmdlet returns a non-terminating error.
This parameter can also get this object through the pipeline or you can set this parameter to an optional
feature object instance.
This example shows how to set the parameter to a fully qualified domain name.
-Identity "corp.contoso.com"
This example shows how to set this parameter to an optional feature object instance named
"optionalFeatureInstance".
-Identity $optionalFeatureInstance
Required? true
Position? 1
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not
generate any output.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Scope <ADOptionalFeatureScope>
Specifies the scope at which the feature is enabled or disabled. Possible values for this parameter include:
Domain or 0
Forest or 1
The following example shows how to set this parameter so that optional features are enabled or disabled within
the scope of the forest.
-Scope Forest
Required? true
Position? 3
Default value
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"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Target <ADEntity>
Specifies the domain or forest in which to modify the optional feature. You can identify the target domain or
forest by providing one of the following values:
Fully-qualified domain name of the forest or domain
Example: corp.Fabrikam.com
NetBIOS name of the forest or domain
Example: corp
Distinguished name of the domain naming context (domain NC)
Example: DC=corp,DC=Fabrikam,DC=com
The following example shows how to set this parameter to a domain NC.
-Target "DC=corp,DC=Fabrikam,DC=com"
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.ActiveDirectory.Management.ADOptionalFeature
An optional feature object is received by the Identity parameter.
OUTPUTS
None
NOTES
This cmdlet does not work with an Active Directory Snapshot.
This cmdlet does not work with a read-only domain controller.
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Disable-ADOptionalFeature 'Feature 1' -Scope ForestOrConfigurationSet -Target 'fabrikam' -Server DC1
Description
-----------
Disable the optional feature (name 'Feature 1') for the forest (NetBIOS name 'fabrikam'). This operation should be
performed against the DC that holds the naming master FSMO role.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>Disable-ADOptionalFeature -Identity 'CN=Feature 1,CN=Optional Features,CN=Directory Service,CN=Windows
NT,CN=Services,CN=Configuration,DC=fabrikam,DC=com' -Scope ForestOrConfigurationSet -Target 'fabrikam.com' -Server
DC1
Description
-----------
Disable the optional feature (dn 'CN=Feature 1,CN=Optional Features,CN=Directory Service,CN=Windows
NT,CN=Services,CN=Configuration,DC=fabrikam,DC=com') for the forest (FQDN name 'fabrikam.com'). This operation
should be performed against the DC that holds the naming master FSMO role.
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>Disable-ADOptionaFeature -Identity '54ec6e43-75a8-445b-aa7b-346a1e096659' -Scope Domain -Target
'DC=fabrikam,DC=com' -Server DC1
Description
-----------
Disable the optional feature (feature GUID '54ec6e43-75a8-445b-aa7b-346a1e096659') for the domain (dn
'DC=ntdev,DC=fabrikam,DC=com'). This operation should be performed against the DC that holds the naming master
FSMO role.
-------------------------- EXAMPLE 4 --------------------------
C:\\PS>Disable-ADOptionalFeature 'Feature 1' -Scope ForestOrConfigurationSet -Target
'CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}' -server server1:50000
Description
-----------
Disable the optional feature (name 'Feature 1') for the AD LDS instance (dn
'CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}'). This operation should be performed against the AD
LDS instance that holds the naming master FSMO role.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291012
Enable-ADOptionalFeature
Get-ADOptionalFeature
SYNOPSIS
Disables an Active Directory optional feature.
SYNTAX
Disable-ADOptionalFeature [-Identity] <ADOptionalFeature> [-Scope] {Unknown | ForestOrConfigurationSet | Domain}
[-Target] <ADEntity> [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-PassThru] [-Server <String>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Disable-ADOptionalFeature disables an Active Directory optional feature that is associated with a particular
Domain Mode or Forest Mode.
The Identity parameter specifies the Active Directory optional feature that you want to disable. You can identify
an optional feature by its distinguished name (DN), feature GUID, or object GUID. You can also set the parameter
to an optional feature object variable, such as $<localOptionalFeatureObject> or you can pass an optional feature
object through the pipeline to the Identity parameter. For example, you can use the Get-ADOptionalFeature cmdlet
to retrieve an optional feature object and then pass the object through the pipeline to the
Disable-ADOptionalFeature cmdlet.
The Scope parameter specifies the scope at which the optional feature is disabled. Possible values for this
parameter are Domain and Forest.
The Target parameter specifies the domain or forest on which the optional feature is disabled. You can identify
the domain or forest by its fully-qualified domain name (FQDN), NetBIOS name, or the distinguished name (DN) of
the domain naming context (domain NC).
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
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADOptionalFeature>
Specifies an Active Directory optional feature object by providing one of the following values. The identifier
in parentheses is the LDAP display name for the attribute.
Fully qualified domain name
Example: corp.contoso.com
Feature GUID (featureGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
Object GUID (objectGUID)
Example: 482ab21c-823e-401e-879a-ac7383d64eb9
The cmdlet searches the default naming context or partition to find the object. If two or more objects are
found, the cmdlet returns a non-terminating error.
This parameter can also get this object through the pipeline or you can set this parameter to an optional
feature object instance.
This example shows how to set the parameter to a fully qualified domain name.
-Identity "corp.contoso.com"
This example shows how to set this parameter to an optional feature object instance named
"optionalFeatureInstance".
-Identity $optionalFeatureInstance
Required? true
Position? 1
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not
generate any output.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Scope <ADOptionalFeatureScope>
Specifies the scope at which the feature is enabled or disabled. Possible values for this parameter include:
Domain or 0
Forest or 1
The following example shows how to set this parameter so that optional features are enabled or disabled within
the scope of the forest.
-Scope Forest
Required? true
Position? 3
Default value
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"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Target <ADEntity>
Specifies the domain or forest in which to modify the optional feature. You can identify the target domain or
forest by providing one of the following values:
Fully-qualified domain name of the forest or domain
Example: corp.Fabrikam.com
NetBIOS name of the forest or domain
Example: corp
Distinguished name of the domain naming context (domain NC)
Example: DC=corp,DC=Fabrikam,DC=com
The following example shows how to set this parameter to a domain NC.
-Target "DC=corp,DC=Fabrikam,DC=com"
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.ActiveDirectory.Management.ADOptionalFeature
An optional feature object is received by the Identity parameter.
OUTPUTS
None
NOTES
This cmdlet does not work with an Active Directory Snapshot.
This cmdlet does not work with a read-only domain controller.
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Disable-ADOptionalFeature 'Feature 1' -Scope ForestOrConfigurationSet -Target 'fabrikam' -Server DC1
Description
-----------
Disable the optional feature (name 'Feature 1') for the forest (NetBIOS name 'fabrikam'). This operation should be
performed against the DC that holds the naming master FSMO role.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>Disable-ADOptionalFeature -Identity 'CN=Feature 1,CN=Optional Features,CN=Directory Service,CN=Windows
NT,CN=Services,CN=Configuration,DC=fabrikam,DC=com' -Scope ForestOrConfigurationSet -Target 'fabrikam.com' -Server
DC1
Description
-----------
Disable the optional feature (dn 'CN=Feature 1,CN=Optional Features,CN=Directory Service,CN=Windows
NT,CN=Services,CN=Configuration,DC=fabrikam,DC=com') for the forest (FQDN name 'fabrikam.com'). This operation
should be performed against the DC that holds the naming master FSMO role.
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>Disable-ADOptionaFeature -Identity '54ec6e43-75a8-445b-aa7b-346a1e096659' -Scope Domain -Target
'DC=fabrikam,DC=com' -Server DC1
Description
-----------
Disable the optional feature (feature GUID '54ec6e43-75a8-445b-aa7b-346a1e096659') for the domain (dn
'DC=ntdev,DC=fabrikam,DC=com'). This operation should be performed against the DC that holds the naming master
FSMO role.
-------------------------- EXAMPLE 4 --------------------------
C:\\PS>Disable-ADOptionalFeature 'Feature 1' -Scope ForestOrConfigurationSet -Target
'CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}' -server server1:50000
Description
-----------
Disable the optional feature (name 'Feature 1') for the AD LDS instance (dn
'CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}'). This operation should be performed against the AD
LDS instance that holds the naming master FSMO role.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291012
Enable-ADOptionalFeature
Get-ADOptionalFeature