Share via

Remove-SCVirtualScsiAdapter

  • Reference
Module:
VirtualMachineManager

Removes a virtual SCSI adapter object from VMM.

Syntax

Remove-SCVirtualScsiAdapter
      [-VirtualScsiAdapter] <VirtualSCSIAdapter>
      [-JobGroup <Guid>]
      [-RunAsynchronously]
      [-PROTipID <Guid>]
      [-JobVariable <String>]
      [-WhatIf]
      [-Confirm]
      [-OnBehalfOfUser <String>]
      [-OnBehalfOfUserRole <UserRole>]
      [<CommonParameters>]

Description

The Remove-SCVirtualScsiAdapter cmdlet removes one or more virtual SCSI adapter objects from a virtual machine, virtual machine template, or hardware profile used in a Virtual Machine Manager (VMM) environment.

The Remove-SCVirtualSCSIAdapter cmdlet removes a virtual SCSI adapter successfully only if the adapter does not have any devices attached to it.

A virtual machine on a Citrix XenServer host always has one virtual SCSI adapter. You cannot remove this adapter.

This cmdlet returns the object upon success (with the property MarkedForDeletion set to True) or returns an error message upon failure.

Examples

Example 1: Remove the third virtual SCSI adapter from a virtual machine

PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> $Adapter = Get-SCVirtualSCSIAdapter -VM $VM 
PS C:\> $Adapter[2] | Remove-SCVirtualScsiAdapter

The first command gets the virtual machine object named VM01 and stores the object in the $VM variable.

The second command gets all virtual SCSI adapter objects on VM01 and stores the objects in the $Adapter object array. A virtual machine can have up to four virtual SCSI adapters attached. This example assumes that VM01 has at least three virtual SCSI adapters.

The last command passes the third virtual SCSI adapter ($Adapter[2]) to Remove-SCVirtualScsiAdapter, which removes this virtual SCSI adapter from VM01.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobGroup

Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OnBehalfOfUser

Specifies the name of a user. This cmdlet sets the on behalf of user as the user that this parameter specifies.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OnBehalfOfUserRole

Specifies a user role. This cmdlet sets the on behalf of user role as the user role that this parameter specifies. To obtain a user role object, use the Get-SCUserRole cmdlet.

Type:UserRole
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

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

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

-VirtualScsiAdapter

Specifies a virtual SCSI adapter object for a virtual machine.

Type of Host Number of Virtual SCSI Adapters

Hyper-V: Up to four synthetic virtual SCSI adapters per VM, and up to 64 devices per adapter. Supports a virtual disk drive size up to 2040 GB. Does not support emulated virtual SCSI adapters. VMware ESX: Up to four virtual SCSI adapters per VM, and up to 15 devices per adapter. Supports a virtual disk drive size up to 2048 GB. Citrix XenServer: Always one virtual SCSI adapter per VM, and up to eight devices per adapter. Supports a virtual disk drive size up to 2048 GB.

Type:VirtualSCSIAdapter
Position:0
Default value:None
Required:True
Accept pipeline input:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Notes

  • Requires a VMM virtual SCSI adapter object, which can be retrieved by using the Get-SCVirtualScsiAdapter cmdlet.