New-SCVirtualScsiAdapter

New-SCVirtualScsiAdapter

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

Syntax

Parameter Set: VM
New-SCVirtualScsiAdapter [[-AdapterID] <Byte> ] -VM <VM> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-ScsiControllerType <VMSCSIControllerType> {DefaultTypeNoType | LsiLogic | BusLogic | ParaVirtualSCSI | LsiLogicSAS} ] [-ShareVirtualScsiAdapter <Boolean> ] [-Synthetic] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: HardwareProfile
New-SCVirtualScsiAdapter [[-AdapterID] <Byte> ] -HardwareProfile <HardwareProfile> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-ScsiControllerType <VMSCSIControllerType> {DefaultTypeNoType | LsiLogic | BusLogic | ParaVirtualSCSI | LsiLogicSAS} ] [-ShareVirtualScsiAdapter <Boolean> ] [-Synthetic] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: JobGroup
New-SCVirtualScsiAdapter [[-AdapterID] <Byte> ] -JobGroup <Guid> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-ScsiControllerType <VMSCSIControllerType> {DefaultTypeNoType | LsiLogic | BusLogic | ParaVirtualSCSI | LsiLogicSAS} ] [-ShareVirtualScsiAdapter <Boolean> ] [-Synthetic] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: Template
New-SCVirtualScsiAdapter [[-AdapterID] <Byte> ] -VMTemplate <Template> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-ScsiControllerType <VMSCSIControllerType> {DefaultTypeNoType | LsiLogic | BusLogic | ParaVirtualSCSI | LsiLogicSAS} ] [-ShareVirtualScsiAdapter <Boolean> ] [-Synthetic] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed 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.

Parameters

-AdapterID<Byte>

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.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-HardwareProfile<HardwareProfile>

Specifies a hardware profile object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-JobGroup<Guid>

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.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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

-ScsiControllerType<VMSCSIControllerType>

Specifies a SCSI controller type. Valid values are: DefaultType, NoType, LsiLogic, BusLogic, ParaVirtualSCSI, LsiLogicSAS.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ShareVirtualScsiAdapter<Boolean>

Specifies that a virtual SCSI adapter will be shared so that it can be used in guest clustering.

TYPE OF HOST USES THIS PARAMETER

------------ --------------------

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."

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Synthetic

Specifies 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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VM<VM>

Specifies a virtual machine object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMMServer<ServerConnection>

Specifies a VMM server object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMTemplate<Template>

Specifies a VMM template object used to create virtual machines.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

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.

  • VirtualSCSIAdapter

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.

Examples

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

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.

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

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

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.

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

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

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.

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

Get-SCHardwareProfile

Get-SCVirtualMachine

Get-SCVirtualScsiAdapter

Get-SCVMMServer

Get-SCVMTemplate

Remove-SCVirtualScsiAdapter

Set-SCVirtualScsiAdapter