Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1
PS XYZ:\>
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type:
SwitchParameter
Aliases:
cf
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Description
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Type:
SwitchParameter
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-DistinguishedName
Type:
String
Aliases:
DN
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Type:
SwitchParameter
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-InputObject
Type:
PSObject
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
True
Accept wildcard characters:
False
-LdapPrefix
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-NewSettingName
Type:
String
Aliases:
NewName
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet may not generate any output.
Type:
SwitchParameter
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Property
Type:
String
Aliases:
ADProperty
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-SearchFilter
Type:
String
Aliases:
LdapFilter
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-SearchScope
Type:
SearchScope
Accepted values:
Base, OneLevel, Subtree
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-SettingName
Type:
String
Aliases:
Name
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Type:
SwitchParameter
Aliases:
wi
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
Inputs
System.Management.Automation.PSObject
Outputs
System.Object
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.