Share via

New-SCVirtualScsiAdapter

  • Reference
Module:
VirtualMachineManager

Creates a virtual SCSI adapter on a virtual machine, virtual machine template, or hardware profile used in VMM.

Syntax

New-SCVirtualScsiAdapter
   [-VMMServer <ServerConnection>]
   -VM <VM>
   [[-AdapterID] <Byte>]
   [-ShareVirtualScsiAdapter <Boolean>]
   [-Synthetic]
   [-ScsiControllerType <VMSCSIControllerType>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
New-SCVirtualScsiAdapter
   [-VMMServer <ServerConnection>]
   -HardwareProfile <HardwareProfile>
   [[-AdapterID] <Byte>]
   [-ShareVirtualScsiAdapter <Boolean>]
   [-Synthetic]
   [-ScsiControllerType <VMSCSIControllerType>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
New-SCVirtualScsiAdapter
   [-VMMServer <ServerConnection>]
   -VMTemplate <Template>
   [[-AdapterID] <Byte>]
   [-ShareVirtualScsiAdapter <Boolean>]
   [-Synthetic]
   [-ScsiControllerType <VMSCSIControllerType>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
New-SCVirtualScsiAdapter
   [-VMMServer <ServerConnection>]
   -JobGroup <Guid>
   [[-AdapterID] <Byte>]
   [-ShareVirtualScsiAdapter <Boolean>]
   [-Synthetic]
   [-ScsiControllerType <VMSCSIControllerType>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The New-SCVirtualScsiAdapter cmdlet creates a virtual SCSI adapter on a virtual machine, virtual machine template, or hardware profile used in a Virtual Machine Manager (VMM) environment. After you create the virtual SCSI adapter, you can use the Set-SCVirtualScsiAdapter cmdlet to modify its settings.

Note: Using the ShareVirtualScsiAdapter parameter to share a virtual SCSI adapter on a virtual machine in order to enable guest clustering is supported only if the virtual machine is deployed on an ESX host. The SharedVirtualScsiAdapter parameter is not used for a virtual machine on a Hyper-V host because a virtual machine on a Hyper-V host uses iSCSI for shared storage.

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

Examples

Example 1: Create a virtual SCSI adapter on a virtual machine

PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> New-SCVirtualScsiAdapter -VM $VM

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

The second command creates a virtual SCSI adapter on VM01.

Example 2: Create a virtual SCSI adapter on a virtual machine template

PS C:\> $VMTemplate = Get-SCVMTemplate | where { $_.Name -eq "VMTemplate01" }
PS C:\> New-SCVirtualScsiAdapter -VMTemplate $VMTemplate

The first command gets the virtual machine template object named VMTemplate01 from the VMM library and stores the object in the $VMTemplate variable.

The second command creates a virtual SCSI adapter on VMTemplate01.

Example 3: Create a virtual SCSI adapter on a hardware profile

PS C:\> $HWProfile = Get-SCHardwareProfile | where { $_.Name -eq "NewHWProfile01" }
PS C:\> New-SCVirtualScsiAdapter -HardwareProfile $HWProfile

The first command gets the hardware profile object named NewHWProfile01 from the VMM library and stores the object in the $HWProfile variable.

The second command creates a virtual SCSI adapter on NewHWProfile01.

Parameters

-AdapterID

Specifies the logical unit number, or LUN ID. Hyper-V and XenServer do not expose this value, and it cannot be changed. For a VMware ESX host, the default is 7 and cannot be changed.

Type:Byte
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-HardwareProfile

Specifies a hardware profile object.

Type:HardwareProfile
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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:True
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

-ScsiControllerType

Specifies a SCSI controller type. Valid values are:

  • DefaultType
  • NoType
  • LsiLogic
  • BusLogic
  • ParaVirtualSCSI
  • LsiLogicSAS
Type:VMSCSIControllerType
Accepted values:DefaultTypeNoType, LsiLogic, BusLogic, ParaVirtualSCSI, LsiLogicSAS
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ShareVirtualScsiAdapter

Indicates whether a virtual SCSI adapter is shared so that it can be used in guest clustering.

  • Hyper-V host: No (for guest clustering, use iSCSI storage)
  • XenServer host: No (Xen VMs always have exactly one SCSI adapter)

Note: When sharing a SCSI controller on a virtual machine on an ESX host, VMM defaults the SCSI sharing policy on VMware to "physical."

Type:Boolean
Aliases:Shared
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Synthetic

Indicates that a device, such as a virtual network adapter, on a virtual machine deployed on a Hyper-V host is a high-performance synthetic device. Requires a virtualization-aware guest operating system on the virtual machine.

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

-VM

Specifies a virtual machine object.

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

-VMMServer

Specifies a VMM server object.

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

-VMTemplate

Specifies a VMM template object used to create virtual machines.

Type:Template
Aliases:Template
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

VirtualSCSIAdapter

This cmdlet returns a VirtualSCSIAdapter object.

Notes

  • Requires a VMM virtual machine object, virtual machine template object, or hardware profile object, which can be retrieved by using the Get-SCVirtualMachine, Get-SCVMTemplate, or Get-SCHardwareProfile cmdlets, respectively.