|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Set-NcLdapClient
NAME
Set-NcLdapClient
SYNOPSIS
Modify an existing Lightweight Directory Access Protocol (LDAP) client confi
guration.
SYNTAX
Set-NcLdapClient [-Name] <String> [-Schema <String>] [-Servers <String[]>] [
-AdDomain <String>] [-PreferredAdServers <String[]>] [-BindAsCifsServer [<Bo
olean>]] [-TcpPort <Int32>] [-QueryTimeout <Int32>] [-MinBindLevel <String>]
[-BindDn <String>] [-BindPassword <String>] [-BaseDn <String>] [-BaseScope
<String>] [-UserDn <String>] [-UserScope <String>] [-GroupDn <String>] [-Gro
upScope <String>] [-NetGroupDn <String>] [-NetGroupScope <String>] [-Control
ler <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Modify an existing Lightweight Directory Access Protocol (LDAP) client confi
guration.
PARAMETERS
-Name <String>
The name of the LDAP client configuration.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Schema <String>
LDAP schema to use for this configuration. The list of possible schemas
can be obtained using the Get-NcLdapClientSchema cmdlet.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Servers <String[]>
List of LDAP Server IP addresses to use for this configuration. The opti
on is NOT applicable for configurations using Active Directory LDAP serv
ers.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AdDomain <String>
The Active Directory Domain Name for this LDAP configuration. The option
is ONLY applicable for configurations using Active Directory LDAP serve
rs.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-PreferredAdServers <String[]>
Preferred Active Directory (AD) Domain controllers to use for this confi
guration. This option is ONLY applicable for configurations using Active
Directory LDAP servers
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-BindAsCifsServer [<Boolean>]
If true, the cluster will use the CIFS server's credentials to bind to t
he LDAP server. If omitted, this parameter defaults to 'true' if the con
figuration uses Active Directory LDAP and defaults to 'false' otherwise.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-TcpPort <Int32>
The TCP port on the LDAP server to use for this configuration. If omitte
d, this parameter defaults to 389.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-QueryTimeout <Int32>
Maximum time in seconds to wait for a query response from the LDAP serve
r. The default for this parameter is 3 seconds.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-MinBindLevel <String>
The minimum authentication level that can be used to authenticate with t
he LDAP server. If omitted, this parameter defaults to 'sasl' if the con
figuration uses Active Directory LDAP. For configurations that use LDAP
servers from other vendors, this parameter defaults to 'simple' if a Bin
dDn is specified and 'anonymous' otherwise. Possible values:
"anonymous" - Anonymous bind
"simple" - Simple bind
"sasl" - Simple Authentication and Security Layer (SASL) bind
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-BindDn <String>
The Bind Distinguished Name (DN) is the LDAP identity used during the au
thentication process by the clients. This is required if the LDAP server
does not support anonymous binds. This field is not used if BindAsCifsS
erver is set to 'true'. Example : cn=username,cn=Users,dc=example,dc=com
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-BindPassword <String>
The password to be used with the BindDn.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-BaseDn <String>
Indicates the starting point for searches within the LDAP directory tree
. If omitted, searches will start at the root of the directory tree.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-BaseScope <String>
This indicates the scope for LDAP search. If omitted, this parameter def
aults to 'subtree'. Possible values:
"base" - Search only the base directory entry
"onelevel" - Search the base directory entry and the children of the ba
se entry
"subtree" - Search the base directory entry and all its descendants
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-UserDn <String>
The User Distinguished Name (DN), if specified, is used as the starting
point in the LDAP directory tree for user lookups. If this parameter is
omitted, user lookups will start at the BaseDn.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-UserScope <String>
This indicates the scope for LDAP search when doing user lookups. Possib
le values:
"base" - Search only the base directory entry
"onelevel" - Search the base directory entry and the children of the ba
se entry
"subtree" - Search the base directory entry and all its descendants
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-GroupDn <String>
The Group Distinguished Name (DN), if specified, is used as the starting
point in the LDAP directory tree for group lookups. If not specified, g
roup lookups will start at the BaseDn.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-GroupScope <String>
This indicates the scope for LDAP search when doing group lookups. Possi
ble values:
"base" - Search only the base directory entry
"onelevel" - Search the base directory entry and the children of the ba
se entry
"subtree" - Search the base directory entry and all its descendants
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NetGroupDn <String>
The Netgoup Distinguished Name (DN), if specified, is used as the starti
ng point in the LDAP directory tree for netgroup lookups. If not specifi
ed, netgroup lookups will start at the BaseDn.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NetGroupScope <String>
This indicates the scope for LDAP search when doing netgroup lookups. Po
ssible values:
"base" - Search only the base directory entry
"onelevel" - Search the base directory entry and the children of the ba
se entry
"subtree" - Search the base directory entry and all its descendants
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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
-WhatIf
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm
Required? false
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.LdapClient
NOTES
Category: ldap
API: ldap-client-modify
Family: cluster
RELATED LINKS
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|