Invoke-CMDeviceRetire

Retires devices.

Syntax

Invoke-CMDeviceRetire
      -Id <Int32>
      [-Force]
      [-Cancel]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-CMDeviceRetire
      -InputObject <IResultObject>
      [-Force]
      [-Cancel]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-CMDeviceRetire
      -Name <String>
      [-Force]
      [-Cancel]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Invoke-CMDeviceRetire cmdlet retires one or more devices. A retired device is no longer active in Microsoft System Center Configuration Manager. It does not receive new policies or policy updates. Retired devices remain listed until a maintenance task removes them.

Examples

Example 1: Retire a named device

PS C:\>Invoke-CMDeviceRetire -DeviceName "Computer073"

This command retires the computer named Computer073.

Required Parameters

-Id
Type:Int32
Aliases:DeviceId, ResourceId
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Specifies a CMDevice object. To obtain a CMDevice object, use the Get-CMDevice cmdlet.

Type:IResultObject
Aliases:Device
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name
Type:String
Aliases:DeviceName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Cancel
Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-DisableWildcardHandling

DisableWildcardHandling treats wildcard characters as literal character values. Cannot be combined with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ForceWildcardHandling

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Cannot be combined with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False