Remove-CMBootImage

Remove-CMBootImage

Removes an operating system boot image.

Syntax

Parameter Set: SearchByIdMandatory
Remove-CMBootImage -Id <String[]> [-Force] [-SecuredScopeNames <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByNameMandatory
Remove-CMBootImage -Name <String> [-Force] [-SecuredScopeNames <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByValueMandatory
Remove-CMBootImage -InputObject <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-CMBootImage cmdlet removes a Windows Preinstallation Environment (Windows PE) operating system boot image from Microsoft System Center 2012 SP1 Configuration Manager.

You must run Remove-CMBootImage on the computer that is running the Systems Management Server (SMS) provider. The computer account of the computer that is running the SMS provider must have Read and Write access to the package source of the boot image. For more information about the SMS provider, see Planning for the SMS Provider in Configuration Manager (https://go.microsoft.com/fwlink/?LinkID=263566) on TechNet.

Parameters

-Force

Forces the command to run without asking for user confirmation.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Id<String[]>

Specifies an array of boot images identifiers. You can get a boot image object by using the Get-CMBootImage cmdlet.

Aliases

PackageId

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<IResultObject>

Specifies a boot image object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies a name of a boot image.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SecuredScopeNames<String>

Specifies a secured scope name.

Aliases

none

Required?

false

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: Remove a boot image object that is identified by using its ID

This command removes a boot image object that is identified by using its ID. You must confirm the action before the command performs it.

PS C:\> Remove-CMBootImage -Id "CM100004" -Confirm

Example 2: Remove a boot image object that is identified by using its name

This command removes a boot image object that is identified by using its name. You must confirm the action before the command performs it.

PS C:\> Remove-CMBootImage -Name "Boot image (86)" -Confirm

Get-CMBootImage

New-CMBootImage

Set-CMBootImage

Planning for the SMS Provider in Configuration Manager