Register-SCStorageLogicalUnit

Reference

Module:: VirtualMachineManager

Associates a logical unit with a host.

Syntax

Register-SCStorageLogicalUnit
        [-StorageLogicalUnit] <StorageLogicalUnit[]>
        -JobGroup <Guid>
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Register-SCStorageLogicalUnit
        [-StorageLogicalUnit] <StorageLogicalUnit[]>
        [-JobGroup <Guid>]
        -VM <VM[]>
        [-AddVM <VM>]
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Register-SCStorageLogicalUnit
        [-StorageLogicalUnit] <StorageLogicalUnit[]>
        [-JobGroup <Guid>]
        -VMHost <Host>
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Register-SCStorageLogicalUnit
        [-StorageLogicalUnit] <StorageLogicalUnit[]>
        [-JobGroup <Guid>]
        -StorageFileServer <StorageFileServer>
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Register-SCStorageLogicalUnit
        [-StorageLogicalUnit] <StorageLogicalUnit[]>
        [-StorageEndpoints <String[]>]
        [-StorageGroupName <String>]
        -StorageInitiators <String[]>
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Register-SCStorageLogicalUnit
        [-StorageLogicalUnit] <StorageLogicalUnit[]>
        -VMHostCluster <HostCluster>
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Description

The Register-SCStorageLogicalUnit cmdlet associates a logical unit with a virtual machine host. The logical unit appears in the operating system as a disk.

Examples

Example 1: Register a logical unit with a host

PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01"
PS C:\> $LU = Get-SCStorageLogicalUnit -Name "LUN01"
PS C:\> Register-SCStorageLogicalUnit -StorageLogicalUnit $LU -VMHost $VMHost

The first command gets the host object named VMHost01 and stores the object in the $VMHost variable.

The second command gets the storage logical unit object named LUN01 and stores the object in the $LU variable.

The last command registers LUN01 with VMHost01.

Parameters

-AddVM

Specifies a virtual machine object.

Type:	VM
Position:	Named
Default value:	None
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:	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

-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

-StorageEndpoints

Specifies an array of storage endpoints.

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

-StorageFileServer

Specifies a storage file server object.

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

-StorageGroupName

Specifies the name of a storage group.

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

-StorageInitiators

Specifies an array of storage initiators.

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

-StorageLogicalUnit

Specifies an array of storage logical unit objects.

Type:	StorageLogicalUnit[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VM

Specifies an array of virtual machine objects.

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

-VMHost

Specifies a virtual machine host object. VMM supports Hyper-V hosts, VMware ESX hosts, and Citrix XenServer hosts.

For more information about each type of host, see the Add-SCVMHost cmdlet.

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

-VMHostCluster

Specifies a VMM host cluster object.

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

Outputs

StorageDisk

This cmdlet returns a StorageDisk object.