Get-SCStorageFileShare
Get-SCStorageFileShare
Gets a storage file share.
Syntax
Parameter Set: All
Get-SCStorageFileShare [[-Name] <String> ] [-All] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: FilterByLibraryServer
Get-SCStorageFileShare [[-Name] <String> ] -LibraryServer <LibraryServer> [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: FilterByVMHost
Get-SCStorageFileShare [[-Name] <String> ] -VMHost <Host> [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: FilterByVMHostCluster
Get-SCStorageFileShare [[-Name] <String> ] -VMHostCluster <HostCluster> [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ID
Get-SCStorageFileShare [[-Name] <String> ] [-ID <Guid]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCStorageFileShare cmdlet gets a storage file share from the Virtual Machine Manager (VMM) database.
Parameters
-All
Indicates that this cmdlet retrieves a full list of all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All
retrieves all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ID<Guid]>
Specifies the numerical identifier as a globally unique identifier (GUID) for a specific object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LibraryServer<LibraryServer>
Specifies a VMM library server object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a VMM object.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMHost<Host>
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, type Get-Help Add-SCVMHost -detailed
. See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMHostCluster<HostCluster>
Specifies a VMM host cluster object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
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.
- StorageFileShare
Examples
Example 1: Get a storage file share by its name
The first command gets the storage file share object named FileShare01, and then stores the object in the $FileShare variable.
The second command displays information about the storage file share stored in FileShare01.
PS C:\> $FileShare = Get-SCStorageFileShare -Name "FileShare01"
PS C:\> $FileShare