Remove-SCVMXComputerConfiguration

Remove-SCVMXComputerConfiguration

Removes a VMX computer configuration object from VMM.

Syntax

Parameter Set: Default
Remove-SCVMXComputerConfiguration [-VMXComputerConfiguration] <VmxMachineConfiguration> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Remove-SCVMXComputerConfiguration cmdlet removes one or more VMX computer configuration objects from the Virtual Machine Manager (VMM) database.

This cmdlet returns the object upon success, with the property MarkedForDeletion set to TRUE, or returns an error message upon failure.

Parameters

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMXComputerConfiguration<VmxMachineConfiguration>

Specifies a VMX computer configuration object.


Aliases

MachineConfig,VMXMachineConfig

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

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 (http://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.

Notes

  • Requires a VMM VMX computer configuration object, which can be retrieved by using the Get-SCVMXComputerConfiguration cmdlet.

Examples

Example 1: Remove all VMX computer configurations without being prompted to confirm each deletion

The first command retrieves all VMX computer configuration objects from the VMM database on VMMServer01, and then stores these objects in the $VMXComputerConfigs object array.

The second command passes each object in $VMXComputerConfigs to Remove-SCVMXComputerConfiguration That cmdlet removes each VMX computer configuration object.


PS C:\> $VMXComputerConfigs = Get-SCVMXComputerConfiguration -VMMServer "VMMServer01.Contoso.com"
PS C:\> $VMXComputerConfigs | Remove-SCVMXComputerConfiguration

Related topics

Community Additions

ADD
Show: