Register-SCStorageFileShare

Reference

Module:: VirtualMachineManager

Registers a storage file share with a VM host, cluster, or library server.

Syntax

Register-SCStorageFileShare
        -VMHost <Host>
        -FileSharePath <String>
        [-JobGroup <Guid>]
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Register-SCStorageFileShare
        -VMHost <Host>
        -StorageFileShare <StorageFileShare>
        [-JobGroup <Guid>]
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Register-SCStorageFileShare
        -VMHostCluster <HostCluster>
        -FileSharePath <String>
        [-JobGroup <Guid>]
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Register-SCStorageFileShare
        -VMHostCluster <HostCluster>
        -StorageFileShare <StorageFileShare>
        [-JobGroup <Guid>]
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Register-SCStorageFileShare
        -LibraryServer <LibraryServer>
        -StorageFileShare <StorageFileShare>
        [-JobGroup <Guid>]
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Register-SCStorageFileShare
        -LibraryServer <LibraryServer>
        -FileSharePath <String>
        [-JobGroup <Guid>]
        [-RunAsynchronously]
        [-PROTipID <Guid>]
        [-JobVariable <String>]
        [<CommonParameters>]

Description

The Register-SCStorageFileShare cmdlet registers a storage file share with a virtual machine host, cluster, or library server.

Examples

PS C:\> $FileShare = Get-SCStorageFileShare -Name "FileShare01" 
PS C:\> $LibServer = Get-SCLibraryServer -ComputerName "LibraryServer01.Contoso.com"
PS C:\> Register-SCStorageFileShare -StorageFileShare $FileShare -LibraryServer $LibServer

The first command gets the storage file share object named FileShare01 and stores the object in the $FileShare variable.

The second command gets the VMM library server object named LibraryServer01 and stores the object in the $LibServer variable.

The last command registers FileShare01 with LibraryServer01.

Parameters

-FileSharePath

Specifies the path to the file share.

Type:	String
Position:	Named
Default value:	None
Required:	True
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:	False
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

-LibraryServer

Specifies a VMM library server object.

Type:	LibraryServer
Position:	Named
Default value:	None
Required:	True
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

-StorageFileShare

Specifies a storage file share.

Type:	StorageFileShare
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

StorageFileShare

This cmdlet returns a StorageFileShare object.