< Back
New-NSldapserver
Post
NAME New-NSldapserver
SYNOPSIS
The new-NSldapserver creates an ldap server configuration.
SYNTAX
New-NSldapserver -basedn <string> -binddn <string> -ipaddress <string> -logonattribute <string> -name <string>
-password <string> -port <ushort> [-authentication <string>] [-groupattribute <string>] [-returnobject
<SwitchParameter>] [-searchfilter <string>] [-securitytype <string>] [-session <nitro_service>] [-ssoattribute
<string>] [-subattribute <string>] [<CommonParameters>]
DESCRIPTION
Use to create an ldap server.
PARAMETERS
-session <nitro_service>
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-name <string>
Specifies the name of the ldap server (ldap action)
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ipaddress <string>
Specifies the ip address of the ldap server
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-port <ushort>
Specifies the port
Required? true
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-securitytype <string>
Specifies the type of connection to the ldap server. Default is "PLAINTEXT" Possible values = PLAINTEXT, TLS,
SSL.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-basedn <string>
Specifies the base DN in Active Directory from where searches start. Hence, this specifies the scope. User
accounts outside of this cannot authenticate. On the other hand, specify the root of a domain can have a
performance impact (for large directories) and potentially be a security risk.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-binddn <string>
Specifies the credential used to connect to Active Directory. This is specified as a UPN.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-password <string>
Specifies the password
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-logonattribute <string>
Specifies logon attribute. Most common is 'sAMAccountName' or 'UserPrincipalName'
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-groupattribute <string>
Specifies group membership attribute. Typically "memberOf" for Active Directory
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-subattribute <string>
Specifies sub attribute for group membership. Typically "cn"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ssoattribute <string>
Specifies the attribute used for single sign-on. However, even if SSO is not used, specifying this will ensure
that this attribute is retrieved from AD during logon.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-searchfilter <string>
Specifies a search filter for LDAP searches
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-authentication <string>
Specifies whether this ldap server configuration is used for authentication. If set to DISABLED the searches
will do group extraction but not actually perform an authentication challenge.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-returnobject <SwitchParameter>
If set to true, the object that is created is returned. This is useful to testing purposes.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
com.citrix.netscaler.nitro.service.nitro_service
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
System.String
Specifies the name of the ldap server (ldap action)
System.String
Specifies the ip address of the ldap server
System.UInt16
Specifies the port
System.String
Specifies the type of connection to the ldap server. Default is "PLAINTEXT" Possible values = PLAINTEXT, TLS,
SSL.
System.String
Specifies the base DN in Active Directory from where searches start. Hence, this specifies the scope. User
accounts outside of this cannot authenticate. On the other hand, specify the root of a domain can have a
performance impact (for large directories) and potentially be a security risk.
System.String
Specifies the credential used to connect to Active Directory. This is specified as a UPN.
System.String
Specifies the password
System.String
Specifies logon attribute. Most common is 'sAMAccountName' or 'UserPrincipalName'
System.String
Specifies group membership attribute. Typically "memberOf" for Active Directory
System.String
Specifies sub attribute for group membership. Typically "cn"
System.String
Specifies the attribute used for single sign-on. However, even if SSO is not used, specifying this will ensure
that this attribute is retrieved from AD during logon.
System.String
Specifies a search filter for LDAP searches
System.String
Specifies whether this ldap server configuration is used for authentication. If set to DISABLED the searches
will do group extraction but not actually perform an authentication challenge.
System.Management.Automation.SwitchParameter
If set to true, the object that is created is returned. This is useful to testing purposes.
OUTPUTS
com.citrix.netscaler.nitro.resource.config.authentication.authenticationldapaction
---------- EXAMPLE 1 ----------
new-nsldapserver -session $session -name "LDAP-asrv" -ipaddress "10.5.1.22" -securityType "TLS" -basedn
"DC=domain,DC=com" -binddn "admin@domain.com" -password "password" -logonattribute "sAMAccountName"
-groupattribute "memberOf" -subattribute "cn" -ssoattribute "UserPrincipalName"
creating an ldap authentication server for Active Directory
RELATED LINKS
SYNOPSIS
The new-NSldapserver creates an ldap server configuration.
SYNTAX
New-NSldapserver -basedn <string> -binddn <string> -ipaddress <string> -logonattribute <string> -name <string>
-password <string> -port <ushort> [-authentication <string>] [-groupattribute <string>] [-returnobject
<SwitchParameter>] [-searchfilter <string>] [-securitytype <string>] [-session <nitro_service>] [-ssoattribute
<string>] [-subattribute <string>] [<CommonParameters>]
DESCRIPTION
Use to create an ldap server.
PARAMETERS
-session <nitro_service>
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-name <string>
Specifies the name of the ldap server (ldap action)
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ipaddress <string>
Specifies the ip address of the ldap server
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-port <ushort>
Specifies the port
Required? true
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-securitytype <string>
Specifies the type of connection to the ldap server. Default is "PLAINTEXT" Possible values = PLAINTEXT, TLS,
SSL.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-basedn <string>
Specifies the base DN in Active Directory from where searches start. Hence, this specifies the scope. User
accounts outside of this cannot authenticate. On the other hand, specify the root of a domain can have a
performance impact (for large directories) and potentially be a security risk.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-binddn <string>
Specifies the credential used to connect to Active Directory. This is specified as a UPN.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-password <string>
Specifies the password
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-logonattribute <string>
Specifies logon attribute. Most common is 'sAMAccountName' or 'UserPrincipalName'
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-groupattribute <string>
Specifies group membership attribute. Typically "memberOf" for Active Directory
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-subattribute <string>
Specifies sub attribute for group membership. Typically "cn"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ssoattribute <string>
Specifies the attribute used for single sign-on. However, even if SSO is not used, specifying this will ensure
that this attribute is retrieved from AD during logon.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-searchfilter <string>
Specifies a search filter for LDAP searches
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-authentication <string>
Specifies whether this ldap server configuration is used for authentication. If set to DISABLED the searches
will do group extraction but not actually perform an authentication challenge.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-returnobject <SwitchParameter>
If set to true, the object that is created is returned. This is useful to testing purposes.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
com.citrix.netscaler.nitro.service.nitro_service
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
System.String
Specifies the name of the ldap server (ldap action)
System.String
Specifies the ip address of the ldap server
System.UInt16
Specifies the port
System.String
Specifies the type of connection to the ldap server. Default is "PLAINTEXT" Possible values = PLAINTEXT, TLS,
SSL.
System.String
Specifies the base DN in Active Directory from where searches start. Hence, this specifies the scope. User
accounts outside of this cannot authenticate. On the other hand, specify the root of a domain can have a
performance impact (for large directories) and potentially be a security risk.
System.String
Specifies the credential used to connect to Active Directory. This is specified as a UPN.
System.String
Specifies the password
System.String
Specifies logon attribute. Most common is 'sAMAccountName' or 'UserPrincipalName'
System.String
Specifies group membership attribute. Typically "memberOf" for Active Directory
System.String
Specifies sub attribute for group membership. Typically "cn"
System.String
Specifies the attribute used for single sign-on. However, even if SSO is not used, specifying this will ensure
that this attribute is retrieved from AD during logon.
System.String
Specifies a search filter for LDAP searches
System.String
Specifies whether this ldap server configuration is used for authentication. If set to DISABLED the searches
will do group extraction but not actually perform an authentication challenge.
System.Management.Automation.SwitchParameter
If set to true, the object that is created is returned. This is useful to testing purposes.
OUTPUTS
com.citrix.netscaler.nitro.resource.config.authentication.authenticationldapaction
---------- EXAMPLE 1 ----------
new-nsldapserver -session $session -name "LDAP-asrv" -ipaddress "10.5.1.22" -securityType "TLS" -basedn
"DC=domain,DC=com" -binddn "admin@domain.com" -password "password" -logonattribute "sAMAccountName"
-groupattribute "memberOf" -subattribute "cn" -ssoattribute "UserPrincipalName"
creating an ldap authentication server for Active Directory
RELATED LINKS