Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcLdapConfig


NAME
Get-NcLdapConfig

SYNOPSIS
Get the list of Lightweight Directory Access Protocol (LDAP) configurations
in the cluster.

SYNTAX
Get-NcLdapConfig [[-ClientConfig] <String[]>] [-Attributes <LdapConfig>] [-V
serverContext <String>] [-Controller <NcController[]>] [<CommonParameters>]

Get-NcLdapConfig -Template [-VserverContext <String>] [-Controller <NcContro
ller[]>] [<CommonParameters>]

Get-NcLdapConfig -Query <LdapConfig> [-Attributes <LdapConfig>] [-VserverCon
text <String>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Get the list of Lightweight Directory Access Protocol (LDAP) configurations
in the cluster.


PARAMETERS
-ClientConfig <String[]>
The name of an existing Lightweight Directory Access Protocol (LDAP) cli
ent configuration. Data ONTAP wildcards are permitted.

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

-Attributes <LdapConfig>
For improved scalability in large clusters, provide a LdapConfig object
with various fields set to indicate which fields to return on all object
s. Undesired fields should remain set to null. Use "Get-NcLdapConfig -
Template" to get the initially empty LdapConfig object. If not specifie
d, 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 LdapConfig 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 <LdapConfig>
For advanced queries, provide a LdapConfig object with various fields se
t to indicate which records to retrieve. Other fields should remain set
to null. Use "Get-NcLdapConfig -Template" to get the initially empty L
dapConfig 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.Ldap.LdapConfig


NOTES


Category: ldap
API: ldap-config-get-iter
Family: cluster, vserver

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

C:\PS>Get-NcLdapConfig -VserverContext lemon


Get the LDAP configuration for Vserver lemon.


NcController : 192.168.182.144
ClientConfig : ldap_client
ClientEnabled : False
ClientEnabledSpecified : True



RELATED LINKS
New-NcLdapConfig
Set-NcLdapConfig
Remove-NcLdapConfig







 Data ONTAP® PowerShell Toolkit