Share via

Get-SCStorageFileShare

  • Reference
Module:
VirtualMachineManager

Gets a storage file share.

Syntax

Get-SCStorageFileShare
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   [-All]
   [<CommonParameters>]
Get-SCStorageFileShare
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   -VMHost <Host>
   [<CommonParameters>]
Get-SCStorageFileShare
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   -VMHostCluster <HostCluster>
   [<CommonParameters>]
Get-SCStorageFileShare
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   -LibraryServer <LibraryServer>
   [<CommonParameters>]
Get-SCStorageFileShare
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   [-ID <Guid>]
   [<CommonParameters>]

Description

The Get-SCStorageFileShare cmdlet gets a storage file share from the Virtual Machine Manager (VMM) database.

Examples

Example 1: Get a storage file share by its name

PS C:\> $FileShare = Get-SCStorageFileShare -Name "FileShare01" 
PS C:\> $FileShare

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

The second command displays information about the storage file share stored in FileShare01.

Parameters

-All

Indicates that this cmdlet gets all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All gets all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.

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

-ID

Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.

Type:Guid
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:True
Accept wildcard characters:False

-Name

Specifies the name of a VMM object.

Type:String
Position:0
Default value:None
Required:False
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:True
Accept wildcard characters:False

-VMHostCluster

Specifies a VMM host cluster object.

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

-VMMServer

Specifies a VMM server object.

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

Outputs

StorageFileShare

This cmdlet returns a StorageFileShare object.