Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcCifsLocalGroup


NAME
Get-NcCifsLocalGroup

SYNOPSIS
Get a list of CIFS local groups.

SYNTAX
Get-NcCifsLocalGroup [[-Name] <String[]>] [[-Vserver] <String[]>] [-Attribut
es <CifsLocalGroup>] [-VserverContext <String>] [-Controller <NcController[]
>] [<CommonParameters>]

Get-NcCifsLocalGroup -Template [-VserverContext <String>] [-Controller <NcCo
ntroller[]>] [<CommonParameters>]

Get-NcCifsLocalGroup -Query <CifsLocalGroup> [-Attributes <CifsLocalGroup>]
[-VserverContext <String>] [-Controller <NcController[]>] [<CommonParameters
>]


DESCRIPTION
Get a list of CIFS local groups.


PARAMETERS
-Name <String[]>
The name of one or more CIFS local groups to get. Data ONTAP wildcards
are accepted.

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

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

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

-Attributes <CifsLocalGroup>
For improved scalability in large clusters, provide a CifsLocalGroup obj
ect with various fields set to indicate which fields to return on all ob
jects. Undesired fields should remain set to null. Use "Get-NcCifsLoca
lGroup -Template" to get the initially empty CifsLocalGroup 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 CifsLocalGroup object for use with advanced quer
ies involving the Query attribute.

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

-Query <CifsLocalGroup>
For advanced queries, provide a CifsLocalGroup object with various field
s set to indicate which records to retrieve. Other fields should remain
set to null. Use "Get-NcCifsLocalGroup -Template" to get the initially
empty CifsLocalGroup 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.CifsLocalGroup


NOTES


Category: cifs
API: cifs-local-group-get-iter
Family: cluster, vserver

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

C:\PS>Get-NcCifsLocalGroup


Get all of the CIFS local groups for the current cluster.


GroupName Vserver Description
--------- ------- -----------
BEAM02\PowerShell Toolkit Users beam01 Users that enjo
y using the Data ONTAP PowerShell Toolkit
BUILTIN\Administrators beam01 Built-in Admini
strators group
BUILTIN\Backup Operators beam01 Backup Operator
s group
BUILTIN\Power Users beam01 Restricted admi
nistrative privileges
BUILTIN\Users beam01 All users



RELATED LINKS
Set-NcCifsLocalGroup
New-NcCifsLocalGroup
Rename-NcCifsLocalGroup
Remove-NcCifsLocalGroup







 Data ONTAP® PowerShell Toolkit