Get-SCStorageFileShare
Gets a storage file share.
Syntax
All (Default)
Get-SCStorageFileShare
[[-Name] <String>]
[-VMMServer <ServerConnection>]
[-All]
[<CommonParameters>]
FilterByVMHost
Get-SCStorageFileShare
[[-Name] <String>]
-VMHost <Host>
[-VMMServer <ServerConnection>]
[<CommonParameters>]
FilterByVMHostCluster
Get-SCStorageFileShare
[[-Name] <String>]
-VMHostCluster <HostCluster>
[-VMMServer <ServerConnection>]
[<CommonParameters>]
FilterByLibraryServer
Get-SCStorageFileShare
[[-Name] <String>]
-LibraryServer <LibraryServer>
[-VMMServer <ServerConnection>]
[<CommonParameters>]
ID
Get-SCStorageFileShare
[[-Name] <String>]
[-VMMServer <ServerConnection>]
[-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
All
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ID
Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ID
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LibraryServer
Specifies a VMM library server object.
Parameter properties
| Type: | LibraryServer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FilterByLibraryServer
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of a VMM object.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Host |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FilterByVMHost
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMHostCluster
Specifies a VMM host cluster object.
Parameter properties
| Type: | HostCluster |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FilterByVMHostCluster
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMMServer
Specifies a VMM server object.
Parameter properties
| Type: | ServerConnection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
StorageFileShare
This cmdlet returns a StorageFileShare object.