Get-VsanFileShare
This cmdlet retrieves vSAN file shares based on the name or ID filter.
Syntax
[-Cluster
<Cluster[]>]
[-FileServiceDomain <VsanFileServiceDomain[]>]
[-Name <String[]>]
[-Server <VIServer[]>]
[CommonParameters]
[-FileServiceDomain <VsanFileServiceDomain[]>]
[-Name <String[]>]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
Cluster[] | named |
|
Specifies the vSAN cluster to which the file share belongs. | optional |
|
VsanFileServiceDomain[] | named |
|
Specifies the vSAN file service domain to which the vSAN file share belongs. If not specified, the vSAN file shares under all vSAN file service domains will be queried. | optional |
|
String[] | named |
|
Filters the retrieved vSAN file share by name. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet. |
-Id
<String[]>
[-Server <VIServer[]>]
[CommonParameters]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | named |
|
Filters the retrieved vSAN file share by ID. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet. |
Output
VMware.VimAutomation.Storage.Types.V1.Vsan.FileService.VsanFileShare
Examples
Example 1
Get-VsanFileShare -FileServiceDomain $fileServiceDomain
Retrieves the vSAN file share which belongs to the $fileServiceDomain file service domain.
Example 2
Get-VsanFileShare -Cluster $cluster -Name "FileShare1"
Retrieves the vSAN file share named "FileShare1" from the $cluster vSAN cluster.
Related Commands
VsanFileServerIpConfig
This cmdlet creates a vSAN file service IP configuration at the client side.
VsanFileServiceDomain
This cmdlet retrieves vSAN file service domains in a vSAN cluster.
This cmdlet modifies the settings of the given vSAN file domains.
This cmdlet removes the specified vSAN file service domain from the vSAN clusters.
This cmdlet creates a file service domain in a vSAN cluster.
VsanFileServiceOvf
This cmdlet downloads a file service OVF file of the specified URL into the OVF repository in vSphere.
VsanFileServiceOvfInfo
This cmdlet retrieves a vSAN file service OVF information.
VsanFileShare
This cmdlet retrieves vSAN file shares based on the name or ID filter.
This cmdlet modifies the configuration of a specified vSAN file share.
This cmdlet removes vSAN file shares.
This cmdlet creates a new vSAN file share in a specified file service domain.
VsanFileShareNetworkPermission
New-VsanFileShareNetworkPermission -IPSetOrSubnet -VsanFileShareAccessPermission [-AllowSquashRoot] [-WhatIf] [-Confirm] []
VsanFileShareSnapshot
This cmdlet retrieves vSAN file share snapshots based on the name or other filters.
This cmdlet removes vSAN file share snapshots.
This cmdlet creates a vSAN file share snapshot for the specified vSAN file share.
