Get-SmbShare
SYNOPSIS
Gets details of the SMB shares on a PowerStore cluster.
SYNTAX
All (Default)
Get-SmbShare [-Cluster] <Cluster> [-Identify] [<CommonParameters>]
ById
Get-SmbShare [-Cluster] <Cluster> -Id <String[]> [<CommonParameters>]
ByName
Get-SmbShare [-Cluster] <Cluster> -Name <String[]> [<CommonParameters>]
DESCRIPTION
Gets details of the SMB shares on a PowerStore cluster. The options include listing all SMB shares on the cluster, getting SMB shares by ID or name.
In this command, SMB share is corresponding to the related CIFS resource in Unisphere REST API.
EXAMPLES
Example 1
PS C:\> Get-SmbShare -Cluster $cluster
Where $cluster is a PowerStore cluster instance. Returns a list of all SMB shares on the PowerStore cluster.
Example 2
PS C:\> Get-SmbShare -Cluster $cluster -Identify
Where $cluster is a PowerStore cluster instance. Returns a list of Identity objects with the ID and name of each SMB share on the PowerStore cluster.
Example 3
PS C:\> Get-SmbShare -Cluster $cluster -Id id1,id2
Where $cluster is a PowerStore cluster instance. Returns SMB shares with IDs id1 and id2 on the PowerStore cluster.
Example 4
PS C:\> Get-SmbShare -Cluster $cluster -Name name1,name2
Where $cluster is a PowerStore cluster instance. Returns SMB shares with names name1 and name2 on the PowerStore cluster.
Example 5
PS C:\> Get-SmbShare -Cluster $cluster -FileSystemId id1,id2
Where $cluster is a PowerStore cluster instance. Returns SMB shares with file system IDs id1 and id2 on the PowerStore cluster.
PARAMETERS
-Cluster
The PowerStore cluster instance.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Identify
Returns Identity objects which contain the ID and name properties of each entity.
Type: SwitchParameter
Parameter Sets: All
Aliases: List
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
The SMB share ID.
Type: String[]
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Name
The SMB share name.
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FileSystemId
ID of the File System tied to the SMB share.
Type: String[]
Parameter Sets: ByFilesystemId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.