Get-VsanFileServiceDomain Command | Vmware PowerCLI Reference

Get-VsanFileServiceDomain

This cmdlet retrieves vSAN file service domains in a vSAN cluster.

Syntax

Get-VsanFileServiceDomain
-Id < String[] >
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Id String[] named
Filters the retrieved vSAN file service domains by ID.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
 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.
Get-VsanFileServiceDomain
[-Cluster < Cluster[] > ]
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Cluster Cluster[] named
  • pipeline
  • wildcards
 Specifies the vSAN cluster to which the file service domain belongs.
optional Name String[] named
  • wildcards
 Filters the retrieved vSAN file service domains by name.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
 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.VsanFileServiceDomain

Examples

Example 1 

Get-VsanFileServiceDomain -Cluster $cluster

Retrieves the vSAN file service domain from the $cluster vSAN cluster.

Example 2 

Get-VsanFileServiceDomain -Cluster $cluster -Name "MyDomain"

Retrieves the vSAN file service domain named "MyDomain" 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 creates a file service domain in a vSAN cluster.

This cmdlet removes the specified vSAN file service domain from the vSAN clusters.

This cmdlet modifies the settings of the given vSAN file domains.

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 creates a new vSAN file share in a specified file service domain.

This cmdlet removes vSAN file shares.

This cmdlet modifies the configuration of a specified vSAN file share.

VsanFileShareNetworkPermission

New-VsanFileShareNetworkPermission -IPSetOrSubnet <string> -VsanFileShareAccessPermission <VsanFileShareAccessType> [-AllowSquashRoot] [-WhatIf] [-Confirm] [<CommonParameters>]

VsanFileShareSnapshot

This cmdlet retrieves vSAN file share snapshots based on the name or other filters.

This cmdlet creates a vSAN file share snapshot for the specified vSAN file share.

This cmdlet removes vSAN file share snapshots.