Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcCifsSymlink


NAME
Get-NcCifsSymlink

SYNOPSIS
Get a list of CIFS symbolic link path mappings.

SYNTAX
Get-NcCifsSymlink [[-CifsServer] <String[]>] [[-Share] <String[]>] [[-UnixPa
th] <String[]>] [[-Locality] <String[]>] [-Attributes <CifsSymlink>] [-Vserv
erContext <String>] [-Controller <NcController[]>] [<CommonParameters>]

Get-NcCifsSymlink -Template [-VserverContext <String>] [-Controller <NcContr
oller[]>] [<CommonParameters>]

Get-NcCifsSymlink -Query <CifsSymlink> [-Attributes <CifsSymlink>] [-Vserver
Context <String>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Get a list of CIFS symbolic link path mappings.


PARAMETERS
-CifsServer <String[]>
The destination CIFS server name for the mapping to which the symbolic l
ink is mapped. The default is the local CIFS server.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Share <String[]>
The CIFS share name on the destination CIFS server to which the symbolic
link is mapped. This is a UTF-8 string and supports localization.

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-UnixPath <String[]>
The UNIX path prefix to be matched for the mapping. If the prefix of the
target path in the symbolic link matches against this field, this entry
of symbolic link path mapping would be used. The path is a UTF-8 string
and supports localization. The path must start and end with a forward s
lash ('/'). For example '/usr/local/'.

Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Locality <String[]>
This field specifies whether the CIFS symbolic link is a local link or w
ide link. A local symbolic link maps to the local CIFS share, whereas a
wide symbolic link maps to any CIFS share on the network. If the CIFS se
rver matches the VServer's NetBIOS name then the default value is local
otherwise widelink. Possible values:
"local" - Share On This VServer
"widelink" - Share On Another CIFS Server

Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Attributes <CifsSymlink>
For improved scalability in large clusters, provide a CifsSymlink object
with various fields set to indicate which fields to return on all objec
ts. Undesired fields should remain set to null. Use "Get-NcCifsSymlink
-Template" to get the initially empty CifsSymlink object. If not speci
fied, all data is returned for each object.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Template
Specify to get an empty CifsSymlink object for use with advanced queries
involving the Query attribute.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Query <CifsSymlink>
For advanced queries, provide a CifsSymlink object with various fields s
et to indicate which records to retrieve. Other fields should remain se
t to null. Use "Get-NcCifsSymlink -Template" to get the initially empty
CifsSymlink object.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.C.Types.Cifs.CifsSymlink


NOTES


Category: cifs
API: cifs-symlink-get-iter
Family: cluster, vserver

-------------- Example 1 --------------

C:\PS>Get-NcCifsSymlink


Get all the CIFS symlinks on the current cluster or vserver.


CifsServer ShareName UnixPath Cif
sPath Locality
---------- --------- -------- ---
----- --------
CIFS01 cifsvol1 /usr/user/ /ci
fsvol1/user/ local



RELATED LINKS
Add-NcCifsSymlink
Remove-NcCifsSymlink
Set-NcCifsSymlink







 Data ONTAP® PowerShell Toolkit