Clear-CMPxeDeployment
Clear-CMPxeDeployment
Clears the status of the most recent PXE deployment in Configuration Manager.
Syntax
Parameter Set: SearchByNameMandatory
Clear-CMPxeDeployment -DeviceCollectionName <String[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByIdMandatory
Clear-CMPxeDeployment -DeviceCollectionId <String[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByIdMandatory__Device
Clear-CMPxeDeployment -ResourceId <String[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByNameMandatory_Device
Clear-CMPxeDeployment -DeviceName <String[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Clear-CMPxeDeployment -DeviceCollection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory__Device
Clear-CMPxeDeployment -Device <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Clear-CMPxeDeployment cmdlet clears the status of the most recent Pre-Boot EXecution Environment (PXE) deployment in Microsoft System Center 2012 SP1 Configuration Manager.
You can redeploy a required PXE deployment for a collection of devices. Clear the status of the last PXE deployment assigned to that System Center 2012 Configuration Manager collection. System Center 2012 Configuration Manager redeploys the most recent required deployments.
Parameters
-Device<IResultObject>
Specifies a device object. To obtain a device object, use the Get-CMDevice cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceCollection<IResultObject>
Specifies a device collection object. To obtain a device collection object, use the Get-CMDeviceCollection cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceCollectionId<String[]>
Specifies an array of IDs of device collections.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceCollectionName<String[]>
Specifies an array of names of device collections.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceName<String[]>
Specifies an array of names of devices.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ResourceId<String[]>
Specifies an array of IDs for resources. The cmdlet clears the status of the PXE deployment for these resources.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Clear a PXE deployment for a device collection
This command clears a PXE deployment identified with a device collection ID.
PS C:\> Clear-CMPxeDeployment -DeviceCollectionId "SMS00072"