Remove-FsrmMgmtProperty
Removes a management property.
Syntax
Remove-FsrmMgmtProperty
[-Namespace <String>]
[-Name] <String>
[-Recurse]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-FsrmMgmtProperty cmdlet removes a management property from a namespace. A management property is a classification property that includes Folder in its AppliesTo property and whose Flags property does not include the Secure value. You can use the Get-FsrmClassificationPropertyDefinition cmdlet to get definitions of classification properties.
Examples
Example 1: Remove all management properties
PS C:\> Remove-FsrmMgmtProperty -Name "FolderUsage_MS"
This command removes all management properties from the server that have the value FolderUsage_MS.
Example 2: Remove a management property by using a namespace
PS C:\> Remove-FsrmMgmtProperty -Name "FolderUsage_MS" -Namespace "C:\Shares"
This command removes all management properties from the namespace C:\Shares that have the value FolderUsage_MS.
Example 3: Remove all management property in a namespace hierarchy
PS C:\> Remove-FsrmMgmtProperty -Name "FolderUsage_MS" -Namespace "C:\Shares" -Recurse
This command removes all management properties that have the value FolderUsage_MS from the namespace C:\Shares and any namespaces below it in the hierarchy.
Example 4: Remove all management properties in a namespace hierarchy
The first command gets all management properties on the server and stores the results in the $props variable.
PS C:\> $props = Get-FsrmMgmtProperty
The second command is a script that identifies management properties where the property applied on folders dos not exist anymore. The script uses the **Remove-FsrmMgmtProperty** cmdlet to remove the management properties for which there is no corresponding property definition on the server.
PS C:\> $nonExistingProperties = $props | where { $_.Exists -ne $true}
foreach ($candidate in $nonExistingProperties)
{foreach ($prop in $_.Properties) {Remove-FsrmMgmtProperty -Name $prop.Name -Namespace $candidate.Namespace}}
This example removes all management properties from namespaces that do not exist on the server. Property definitions are removed from a server by an administrator or as a result of group policy updates. When you remove a property definition, the management property values that the server sets on folders by using the property definition are obsolete.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
You can continue to work in the session while the job completes.
To manage the job, use the *-Job
cmdlets.
To get the job results, use the Receive-Job cmdlet.
For more information about Windows PowerShell background jobs, see about_Jobs.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Type: | CimSession[] |
Aliases: | Session |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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 |
-Name
Specifies the name of a management property. Specify the value of the Name property in a FsrmClassificationPropertyDefinition object.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Namespace
Specifies a local path to a folder.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Recurse
Indicates that this cmdlet removes management properties for all folders that contain management properties in the namespace. If you specify this parameter, you must specify the Namespace parameter.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of 0
is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
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 |