Set-SCVirtualScsiAdapter
Set-SCVirtualScsiAdapter
Changes properties of a virtual SCSI adapter used in VMM.
Syntax
Parameter Set: Default
Set-SCVirtualScsiAdapter [-VirtualScsiAdapter] <VirtualSCSIAdapter> [-AdapterID <Byte]> ] [-JobGroup <Guid]> ] [-JobVariable <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-ScsiControllerType <VMSCSIControllerType> {DefaultTypeNoType | LsiLogic | BusLogic | ParaVirtualSCSI | LsiLogicSAS} ] [-ShareVirtualScsiAdapter <Boolean]> ] [ <CommonParameters>]
Detailed Description
The Set-SCVirtualScsiAdapter cmdlet changes one or more properties of a virtual SCSI adapter used in a Virtual Machine Manager (VMM) environment. Settings that you can modify include specifying whether or not a virtual SCSI adapter is shared and setting the adapter ID.
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 a VMware 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.
Note: Set-SCVirtualScsiAdapter is not used for Citrix XenServer hosts because the SCSI adapter on Citrix XenServer virtual machines is not configurable.
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? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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? |
false |
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 |
-OnBehalfOfUser<System.String>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>
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]>
Indicates whether a virtual SCSI adapter is shared so that it can be used in guest clustering. The types of host and whether they use this parameter are:
Hyper-V: No; for guest clustering, use iSCSI storage.
XenServer: 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 |
Shared |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualScsiAdapter<VirtualSCSIAdapter>
Specifies a virtual SCSI adapter object for a virtual machine. The types of host and number of virtual SCSI adapters are:
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.
Aliases |
none |
Required? |
true |
Position? |
1 |
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
- This cmdlet requires a VMM virtual SCSI adapter object, which can be retrieved by using the Get-SCVirtualScsiAdapter cmdlet.
Examples
Example Example 1: Share a specific virtual SCSI adapter on a virtual machine to enable it for guest clustering.
The first command gets the virtual machine object named VM01, and then stores the object in the $VM variable.
The second command gets the SCSI adapter object on VM01, and then stores the object in the $Adapter variable. This example assumes that VM01 has one virtual SCSI adapter. However, a virtual machine can have up to four virtual SCSI adapters attached.
The last command enables the virtual SCSI adapter object stored in $Adapter and specifies that is it shared so that it can be used in guest clustering.
Note: Using the Shared parameter to share a virtual SCSI adapter on a virtual machine is supported only if the virtual machine is deployed on an ESX host. The Shared parameter is not used for a virtual machine a Hyper-V host because a virtual machine on a Hyper-V host uses iSCSI for shared storage. The Shared parameter is also not used for a virtual machine on a XenServer host because XenServer-based virtual machines always have exactly one SCSI adapter.
PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> $Adapter = Get-SCVirtualScsiAdapter -VM $VM
PS C:\> Set-SCVirtualSCSIAdapter -VirtualScsiAdapter $Adapter -ShareVirtualScsiAdapter $True