Invoke ADCUpdateAaaldapparams - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUpdateAaaldapparams

SYNOPSIS

Update AAA configuration Object.

SYNTAX

Invoke-ADCUpdateAaaldapparams [[-Serverip] <String>] [[-Serverport] <Int32>] [[-Authtimeout] <Double>]
 [[-Ldapbase] <String>] [[-Ldapbinddn] <String>] [[-Ldapbinddnpassword] <String>] [[-Ldaploginname] <String>]
 [[-Searchfilter] <String>] [[-Groupattrname] <String>] [[-Subattributename] <String>] [[-Sectype] <String>]
 [[-Svrtype] <String>] [[-Ssonameattribute] <String>] [[-Passwdchange] <String>]
 [[-Nestedgroupextraction] <String>] [[-Maxnestinglevel] <Double>] [[-Groupnameidentifier] <String>]
 [[-Groupsearchattribute] <String>] [[-Groupsearchsubattribute] <String>] [[-Groupsearchfilter] <String>]
 [[-Defaultauthenticationgroup] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for LDAP parameter resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateAaaldapparams

An example how to update aaaldapparams configuration Object(s).

PARAMETERS

-Serverip

IP address of your LDAP server.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Serverport

Port number on which the LDAP server listens for connections.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Authtimeout

Maximum number of seconds that the Citrix ADC waits for a response from the LDAP server.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Ldapbase

Base (the server and location) from which LDAP search commands should start. If the LDAP server is running locally, the default value of base is dc=netscaler, dc=com.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ldapbinddn

Complete distinguished name (DN) string used for binding to the LDAP server.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ldapbinddnpassword

Password for binding to the LDAP server.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ldaploginname

Name attribute that the Citrix ADC uses to query the external LDAP server or an Active Directory.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Searchfilter

String to be combined with the default LDAP user search string to form the value to use when executing an LDAP search. For example, the following values: vpnallowed=true, ldaploginame=""samaccount"" when combined with the user-supplied username ""bob"", yield the following LDAP search string: ""(;(vpnallowed=true)(samaccount=bob)"".

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Groupattrname

Attribute name used for group extraction from the LDAP server.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Subattributename

Subattribute name used for group extraction from the LDAP server.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sectype

Type of security used for communications between the Citrix ADC and the LDAP server. For the PLAINTEXT setting, no encryption is required. Possible values = PLAINTEXT, TLS, SSL

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Svrtype

The type of LDAP server. Possible values = AD, NDS

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ssonameattribute

Attribute used by the Citrix ADC to query an external LDAP server or Active Directory for an alternative username. This alternative username is then used for single sign-on (SSO).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Passwdchange

Accept password change requests. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Nestedgroupextraction

Queries the external LDAP server to determine whether the specified group belongs to another group. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Maxnestinglevel

Number of levels up to which the system can query nested LDAP groups.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Groupnameidentifier

LDAP-group attribute that uniquely identifies the group. No two groups on one LDAP server can have the same group name identifier.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Groupsearchattribute

LDAP-group attribute that designates the parent group of the specified group. Use this attribute to search for a group's parent group.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Groupsearchsubattribute

LDAP-group subattribute that designates the parent group of the specified group. Use this attribute to search for a group's parent group.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Groupsearchfilter

Search-expression that can be specified for sending group-search requests to the LDAP server.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 21
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Defaultauthenticationgroup

This is the default group that is chosen when the authentication succeeds in addition to extracted groups.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCUpdateAaaldapparams Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/aaa/aaaldapparams/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️