externalLibs/Carbon/Carbon/UsersAndGroups/Uninstall-User.ps1
|
# Copyright 2012 Aaron Jensen # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. function Uninstall-User { <# .SYNOPSIS Removes a user from the local computer. .DESCRIPTION Removes a *local* user account. If the account doesn't exist, nothing happens. .EXAMPLE Uninstall-User -Username WTarkin Removes the `WTarkin` *local* user account. #> [CmdletBinding(SupportsShouldProcess=$true)] param( [Parameter(Mandatory=$true)] [ValidateLength(1,20)] [string] # The username of the account to remove. $Username ) if( Test-User -Username $username ) { if( $pscmdlet.ShouldProcess( "$Username", "remove local user" ) ) { & (Resolve-NetPath) user $Username /delete } } } Set-Alias -Name 'Remove-User' -Value 'Uninstall-User' |