Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcGroupMapping


NAME
Get-NcGroupMapping

SYNOPSIS
Get the list of group mappings in the cluster.

SYNTAX
Get-NcGroupMapping [[-Position] <Int16][]>] [[-Direction] <String[]>] [[-Vse
rver] <String[]>] [-Attributes <GroupMappingInfo>] [-VserverContext <String>
] [-Controller <NcController[]>] [<CommonParameters>]

Get-NcGroupMapping -Template [-VserverContext <String>] [-Controller <NcCont
roller[]>] [<CommonParameters>]

Get-NcGroupMapping -Query <GroupMappingInfo> [-Attributes <GroupMappingInfo>
] [-VserverContext <String>] [-Controller <NcController[]>] [<CommonParamete
rs>]


DESCRIPTION
Get the list of group mappings in the cluster.


PARAMETERS
-Position <Int16][]>
The position of one or more name mappings in the list of name mappings.
Data ONTAP wildcards are permitted.

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

-Direction <String[]>
The direction which the name mapping is applied. Data ONTAP wildcards a
re permitted.

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

-Vserver <String[]>
Restrict the results to one or more Vservers. Data ONTAP wildcards are
permitted.

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

-Attributes <GroupMappingInfo>
For improved scalability in large clusters, provide an GroupMappingInfo
object with various fields set to indicate which fields to return on all
objects. Undesired fields should remain set to null. Use "Get-NcGroup
Mapping -Template" to get the initially empty GroupMappingInfo object.
If not specified, 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 GroupMappingInfo object for use with advanced qu
eries involving the Query attribute.

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

-Query <GroupMappingInfo>
For advanced queries, provide an GroupMappingInfo object with various fi
elds set to indicate which records to retrieve. Other fields should rem
ain set to null. Use "Get-NcGroupMapping -Template" to get the initiall
y empty GroupMappingInfo 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.GroupMapping.GroupMappingInfo


NOTES


Category: group mapping
API: group-mapping-get-iter
Family: vserver, cluster

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

C:\PS>Get-NcGroupMapping -Direction unix_win


Get all of the unix_win group mappings.


Direction : unix_win
NcController : 10.63.165.62
Pattern : cifs
Position : 1
Replacement : EXAMPLE\\Domain Groups
Vserver : repo
PositionSpecified : True

Direction : unix_win
NcController : 10.63.165.62
Pattern : root
Position : 2
Replacement : EXAMPLE\\Administrators
Vserver : repo
PositionSpecified : True


-------------- Example 2 --------------

C:\PS>$q = Get-NcGroupMapping -Template
$q.Direction = "win_unix"
$q.Replacement = "backup"
Get-NcGroupMapping -Query $q


Get all of the win_unix group mappings that map the unix 'backup' group.


Direction : win_unix
NcController : 10.63.165.62
Pattern : EXAMPLE\\Backup Users
Position : 1
Replacement : backup
Vserver : repo
PositionSpecified : True



RELATED LINKS
New-NcGroupMapping
Set-NcGroupMapping
Remove-NcGroupMapping
Move-NcGroupMapping







 Data ONTAP® PowerShell Toolkit