Remove-HomeDrive
SYNOPSIS
Removes the home drive of an Active Directory user.
SYNTAX
DESCRIPTION
The `Remove-HomeDrive` function removes the home drive of a specified Active Directory user. It validates the user's home drive path, handles specific organizational structures, and moves the home drive to an archive location if it exists.
EXAMPLES
EXAMPLE 1
Removes the home drive for the user "jdoe" and moves it to an archive location if it exists.
PARAMETERS
-user
The identity of the Active Directory user whose home drive will be removed.
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.