powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Remove-WmiObject



NAME
Remove-WmiObject

SYNOPSIS
Deletes an instance of an existing Windows Management Instrumentation (WMI) class.

SYNTAX
Remove-WmiObject [-Class] [-Authentication {Default | None | Connect | Call | Packet | PacketIntegrity | P
acketPrivacy | Unchanged}] [-Authority ] [-ComputerName ] [-Credential ] [-EnableAl
lPrivileges] [-Impersonation {Default | Anonymous | Identify | Impersonate | Delegate}] [-Locale ] [-Namesp
ace ] [-AsJob] [-ThrottleLimit ] [-Confirm] [-WhatIf] []

Remove-WmiObject [-Authentication {Default | None | Connect | Call | Packet | PacketIntegrity | PacketPrivacy | Unc
hanged}] [-Authority ] [-ComputerName ] [-Credential ] [-EnableAllPrivileges] [-Imp
ersonation {Default | Anonymous | Identify | Impersonate | Delegate}] [-Locale ] [-Namespace ] [-As
Job] [-ThrottleLimit ] [-Confirm] [-WhatIf] []

Remove-WmiObject -InputObject [-AsJob] [-ThrottleLimit ] [-Confirm] [-WhatIf] [ eters>]

Remove-WmiObject -Path [-Authentication {Default | None | Connect | Call | Packet | PacketIntegrity | Pack
etPrivacy | Unchanged}] [-Authority ] [-ComputerName ] [-Credential ] [-EnableAllPr
ivileges] [-Impersonation {Default | Anonymous | Identify | Impersonate | Delegate}] [-Locale ] [-Namespace
] [-AsJob] [-ThrottleLimit ] [-Confirm] [-WhatIf] []

Remove-WmiObject [-Authentication {Default | None | Connect | Call | Packet | PacketIntegrity | PacketPrivacy | Unc
hanged}] [-Authority ] [-ComputerName ] [-Credential ] [-EnableAllPrivileges] [-Imp
ersonation {Default | Anonymous | Identify | Impersonate | Delegate}] [-Locale ] [-Namespace ] [-As
Job] [-ThrottleLimit ] [-Confirm] [-WhatIf] []

Remove-WmiObject [-Authentication {Default | None | Connect | Call | Packet | PacketIntegrity | PacketPrivacy | Unc
hanged}] [-Authority ] [-ComputerName ] [-Credential ] [-EnableAllPrivileges] [-Imp
ersonation {Default | Anonymous | Identify | Impersonate | Delegate}] [-Locale ] [-Namespace ] [-As
Job] [-ThrottleLimit ] [-Confirm] [-WhatIf] []


DESCRIPTION
The Remove-WmiObject cmdlet deletes an instance of an existing WMI class.


PARAMETERS
-AsJob []
Runs the command as a background job. Use this parameter to run commands that take an extensive time to comple
te.
Runs the command as a background job. Use this parameter to run commands that take a long time to finish.

When you use the AsJob parameter, the command returns an object that represents the background job and then dis
plays the command prompt. You can continue to work in the session while the job finishes. If Remove-WmiObject i
s used against a remote computer, the job is created on the local computer, and the results from remote compute
rs are automatically returned to the local computer. To manage the job, use the cmdlets that contain the Job no
un (the Job cmdlets). To get the job results, use the Receive-Job cmdlet.

Note: To use this parameter with remote computers, the local and remote computers must be configured for remoti
ng. Additionally, you must start Windows PowerShell by using the "Run as administrator" option in Windows Vista
and later versions of Windows,. For more information, see about_Remote_Requirements.

For more information about Windows PowerShell background jobs, see about_Jobs and about_Remote_Jobs.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Authentication
Specifies the authentication level to be used with the WMI connection. Valid values are:

-1: Unchanged
0: Default
1: None (No authentication in performed.)
2: Connect (Authentication is performed only when the client establishes a relationship with the application.)
3: Call (Authentication is performed only at the beginning of each call when the application receives the reque
st.)
4: Packet (Authentication is performed on all the data that is received from the client.)
5: PacketIntegrity (All the data that is transferred between the client and the application is authenticated a
nd verified.)
6: PacketPrivacy (The properties of the other authentication levels are used, and all the data is encrypted.)

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Authority
Specifies the authority to use to authenticate the WMI connection. You can specify standard NTLM or Kerberos au
thentication. To use NTLM, set the authority setting to "ntlmdomain:", where identifie
s a valid NTLM domain name. To use Kerberos, specify "kerberos:\". You cannot include t
he authority setting when you connect to the local computer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Class
Specifies the name of a WMI class that you want to delete.

Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ComputerName
Specifies the computer against which you want to run the management operation. The value can be a fully qualifi
ed domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (.)
to specify the local computer. The local computer is the default. When the remote computer is in a different do
main from the user, you must use a fully qualified domain name. You can set the value of this parameter by pipi
ng the value to the parameter.

This parameter does not rely on Windows PowerShell remoting, which uses WS-Management ). You can use the Comput
erName parameter of Get-WmiObject even if your computer is not configured to run WS-Management remote commands
.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Credential
Specifies a user account that has permission to perform this action. The default is the current user. Type a us
er name, such as "User01", "Domain01\User01", or "User@Contoso.com". Or, enter a PSCredential object, such as a
n object that is returned by the Get-Credential cmdlet. When you type a user name, you will be prompted for a p
assword.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-EnableAllPrivileges []
Enables all the privileges of the current user before the command makes the WMI call.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Impersonation
Specifies the impersonation level to use. Valid values are:

0: Default (Reads the local registry for the default impersonation level, which is usually set to "3: Impersona
te".)
1: Anonymous (Hides the credentials of the caller.)
2: Identify (Allows objects to query the credentials of the caller.)
3: Impersonate (Allows objects to use the credentials of the caller.)
4: Delegate (Allows objects to permit other objects to use the credentials of the caller.)

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-InputObject
Specifies a ManagementObject object to use as input. When this parameter is used, all other parameters are igno
red.

Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-Locale
Specifies the preferred locale for WMI objects. The Locale parameter is specified as an array in the MS_
format in the preferred order.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Namespace
When used with the Class parameter, this parameter specifies the WMI repository namespace where the referenced
WMI class is located.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Path
Specifies the WMI object path of a WMI class, or specifies the WMI object path of an instance of a WMI class to
delete.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ThrottleLimit
Allows the user to specify a throttling value for the number of WMI operations that can be executed simultaneou
sly. This parameter is used together with the AsJob parameter. The throttle limit applies only to the current c
ommand, not to the session or to the computer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm []
Prompts you for confirmation before executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf []
Describes what would happen if you executed the command without actually executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.Management.ManagementObject
You can pipe a management object to Remove-WmiObject.


OUTPUTS
None or System.Management.Automation.RemotingJob
When you use the AsJob parameter, this cmdlet returns a job object. Otherwise, it does not generate any output.


NOTES





-------------------------- EXAMPLE 1 --------------------------

C:\PS>notepad
C:\PS> $np = get-wmiobject -query "select * from win32_process where name='notepad.exe'"
C:\PS> $np | remove-wmiobject


Description
-----------
This command closes all the instances of Notepad.exe.

The first command starts an instance of Notepad.

The second command uses the Get-WmiObject cmdlet to retrieve the instances of the Win32_Process that correspond to
Notepad.exe and stores them in the $np variable.

The third command passes the object in the $np variable to the Remove-WmiObject cmdlet, which deletes all the insta
nces of Notepad.exe.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>$a = Get-WMIObject -query "Select * From Win32_Directory Where Name ='C:\\Test'"
C:\PS> $a | Remove-WMIObject


Description
-----------
This command deletes the C:\Test directory.

The first command uses the Get-WMIObject cmdlet to query for the C:\Test directory and then stores the object in th
e $a variable.

The second command pipes the $a variable to the Remove-WMIObject, which deletes the directory.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113381
Get-WmiObject
Invoke-WmiMethod
Set-WmiInstance
Get-WSManInstance
Invoke-WSManAction
New-WSManInstance
Remove-WSManInstance