< Back
Get-ScsiLun
Post
NAME Get-ScsiLun
SYNOPSIS
This cmdlet retrieves the SCSI devices available on the vCenter Server system.
SYNTAX
Get-ScsiLun [[-CanonicalName] <String[]>] [-VmHost] <VMHost[]> [-Key <String[]>] [-LunType <String[]>] [-Server
<VIServer[]>] [<CommonParameters>]
Get-ScsiLun [[-CanonicalName] <String[]>] [-Hba] <Hba[]> [-Key <String[]>] [-LunType <String[]>] [-Server
<VIServer[]>] [<CommonParameters>]
Get-ScsiLun [[-CanonicalName] <String[]>] [-Datastore] <Datastore[]> [-Key <String[]>] [-LunType <String[]>]
[-Server <VIServer[]>] [<CommonParameters>]
Get-ScsiLun -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]
DESCRIPTION
This cmdlet retrieves the SCSI devices available on the vCenter Server system. Examples of SCSI logical unit
objects include disks which may contain file system volumes or parts of volumes for the host or might serve as raw
disks to a virtual machine. Other examples include SCSI passthrough devices that can be used by virtual machines.
When retrieving ScsiLun objects by Datastore, the cmdlet returns a ScsiLun object for each host connected to the
specified datastore. ScsiLun objects can be differed by their VMHost property.
PARAMETERS
-CanonicalName <String[]>
Specifies the canonical name of the SCSI devices you want to retrieve. An example of a SCSI canonical name for
Windows is "vmhba0:0:0:0".
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Datastore <Datastore[]>
Specifies the datastores for which you want to retrieve the SCSI devices. This parameter is supported only for
VMFS volumes.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Hba <Hba[]>
Specifies the storage adapters for which you want to retrieve the SCSI devices.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Id <String[]>
Specifies the IDs of the SCSI devices that you want to retrieve.
Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that
matches exactly one of the string values in that list.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Key <String[]>
Specifies the linkable identifiers of the SCSI devices you want to retrieve.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-LunType <String[]>
Specifies the type of the SCSI devices you want to retrieve. The following types are valid:
cdrom communications disk enclosure mediaChanger opticalDevice printer processor scanner
storageArrayController tape unknown worm
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VmHost <VMHost[]>
Specifies the hosts from which you want to retrieve the virtual SCSI devices.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more ScsiLun objects
NOTES
-------------------------- Example 1 --------------------------
Get-ScsiLun -VMHost 10.23.123.100 -LunType disk
Retrieves the SCSI devices of "disk" type for the virtual machine host with an IP address 10.23.123.100.
-------------------------- Example 2 --------------------------
Get-VMHost | Get-ScsiLun -CanonicalName "naa.*"
Retrieves the SCSI devices with canonical names that starts with "naa." on the provided host.
-------------------------- Example 3 --------------------------
$hba = Get-VMHost | Get-VMHostHba -Type ParallelScsi
Get-ScsiLun -Hba $hba -LunType disk
Retrieves the SCSI devices of "disk" type for the specified HBA devices.
-------------------------- Example 4 --------------------------
Get-ScsiLun -Datastore Datastore -Key "key-vim.host.ScsiDisk-*"
For the Datastore datastore, retrieves the SCSI devices that have the specified linkable identifiers.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... siLun.html
Get-ScsiLunPath
Set-ScsiLun
Set-ScsiLunPath
SYNOPSIS
This cmdlet retrieves the SCSI devices available on the vCenter Server system.
SYNTAX
Get-ScsiLun [[-CanonicalName] <String[]>] [-VmHost] <VMHost[]> [-Key <String[]>] [-LunType <String[]>] [-Server
<VIServer[]>] [<CommonParameters>]
Get-ScsiLun [[-CanonicalName] <String[]>] [-Hba] <Hba[]> [-Key <String[]>] [-LunType <String[]>] [-Server
<VIServer[]>] [<CommonParameters>]
Get-ScsiLun [[-CanonicalName] <String[]>] [-Datastore] <Datastore[]> [-Key <String[]>] [-LunType <String[]>]
[-Server <VIServer[]>] [<CommonParameters>]
Get-ScsiLun -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]
DESCRIPTION
This cmdlet retrieves the SCSI devices available on the vCenter Server system. Examples of SCSI logical unit
objects include disks which may contain file system volumes or parts of volumes for the host or might serve as raw
disks to a virtual machine. Other examples include SCSI passthrough devices that can be used by virtual machines.
When retrieving ScsiLun objects by Datastore, the cmdlet returns a ScsiLun object for each host connected to the
specified datastore. ScsiLun objects can be differed by their VMHost property.
PARAMETERS
-CanonicalName <String[]>
Specifies the canonical name of the SCSI devices you want to retrieve. An example of a SCSI canonical name for
Windows is "vmhba0:0:0:0".
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Datastore <Datastore[]>
Specifies the datastores for which you want to retrieve the SCSI devices. This parameter is supported only for
VMFS volumes.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Hba <Hba[]>
Specifies the storage adapters for which you want to retrieve the SCSI devices.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Id <String[]>
Specifies the IDs of the SCSI devices that you want to retrieve.
Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that
matches exactly one of the string values in that list.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Key <String[]>
Specifies the linkable identifiers of the SCSI devices you want to retrieve.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-LunType <String[]>
Specifies the type of the SCSI devices you want to retrieve. The following types are valid:
cdrom communications disk enclosure mediaChanger opticalDevice printer processor scanner
storageArrayController tape unknown worm
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VmHost <VMHost[]>
Specifies the hosts from which you want to retrieve the virtual SCSI devices.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more ScsiLun objects
NOTES
-------------------------- Example 1 --------------------------
Get-ScsiLun -VMHost 10.23.123.100 -LunType disk
Retrieves the SCSI devices of "disk" type for the virtual machine host with an IP address 10.23.123.100.
-------------------------- Example 2 --------------------------
Get-VMHost | Get-ScsiLun -CanonicalName "naa.*"
Retrieves the SCSI devices with canonical names that starts with "naa." on the provided host.
-------------------------- Example 3 --------------------------
$hba = Get-VMHost | Get-VMHostHba -Type ParallelScsi
Get-ScsiLun -Hba $hba -LunType disk
Retrieves the SCSI devices of "disk" type for the specified HBA devices.
-------------------------- Example 4 --------------------------
Get-ScsiLun -Datastore Datastore -Key "key-vim.host.ScsiDisk-*"
For the Datastore datastore, retrieves the SCSI devices that have the specified linkable identifiers.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... siLun.html
Get-ScsiLunPath
Set-ScsiLun
Set-ScsiLunPath