ldapserver¶
LDAP Server
show ldapserver¶
Use this operation to get LDAP server details
Synopsys¶
show ldapserver [id=<string>]
Parameters¶
id
Id is system generated key for all the ldap servers
delete ldapserver¶
Use this operation to delete LDAP server
Synopsys {#synopsys-1 style="margin-left: 20px;"}¶
delete ldapserver id=<string>
Parameters {#parameters-1 style="margin-left: 20px;"}¶
id
Id is system generated key for all the ldap servers
This is a mandatory parameter.
set ldapserver¶
Use this operation to modify LDAP server
Synopsys {#synopsys-2 style="margin-left: 20px;"}¶
set ldapserver id=<string> name=<string> ip_address=<internethost> [port=<int>] [validate_ldap_server_certs=(false | true)] [ldap_host_name=<string>] [sec_type=<string>] [type=<string>] [subattribute_name=<string>] [change_password=(false | true)] [follow_referrals=(false | true)] [max_nesting_level=<int>] [group_search_filter=<string>] [group_attr_name=<string>] [max_ldap_referrals=<int>] [group_search_attribute=<string>] [group_search_subattribute=<string>] [auth_timeout=<int>] [nested_group_extraction=(false | true)] [group_name_identifier=<string>] [default_authentication_group=<string>] [bind_passwd=<stringx>] [bind_dn=<string>] [search_filter=<string>] [login_name=<string>] [base_dn=<string>] [address_type=<int>]
Parameters {#parameters-2 style="margin-left: 20px;"}¶
id
Id is system generated key for all the ldap servers
This is a mandatory parameter.
name
Name of LDAP server
This is a mandatory parameter.
ip_address
The IP address of the LDAP server.
This is a mandatory parameter.
port
The port number on which the LDAP server is running
validate_ldap_server_certs
Validate LDAP Server Certificate
ldap_host_name
Host Name on the certificate from LDAP Server
sec_type
The communication type between the system and the LDAP server
type
The type of LDAP server
subattribute_name
The Sub-Attribute name for group extraction from LDAP server
change_password
Enable change of the user
follow_referrals
Enable following LDAP referrals received from LDAP server
max_nesting_level
Number of levels at which group extraction is allowed
group_search_filter
String to be combined with the default LDAP group search string to form the search value
group_attr_name
The Attribute name for group extraction from the LDAP server
max_ldap_referrals
Maximum number of ldap referrals to follow
group_search_attribute
LDAP group search attribute. Used to determine to which groups a group belongs
group_search_subattribute
LDAP group search subattribute. Used to determine to which groups a group belongs.
auth_timeout
The maximum number of seconds the system will wait for a response from the LDAP server
nested_group_extraction
Enable Nested Group Extraction
group_name_identifier
Name that uniquely identifies a group in LDAP server
default_authentication_group
This is the default group
bind_passwd
The password used to bind to the LDAP server
bind_dn
The full distinguished name used to bind to the LDAP server
search_filter
The String to be combined with the default LDAP user search string to form the value
login_name
The name attribute used by the system to query the external LDAP server
base_dn
The base or node where the ldapsearch should start
address_type
Configuration Type. Values: 0: IPv4, 1: IPv6, -1: Hostname
add ldapserver¶
Use this operation to add LDAP server
Synopsys {#synopsys-3 style="margin-left: 20px;"}¶
add ldapserver type=<string> name=<string> ip_address=<internethost> [port=<int>] [validate_ldap_server_certs=(false | true)] [ldap_host_name=<string>] [sec_type=<string>] [subattribute_name=<string>] [change_password=(false | true)] [follow_referrals=(false | true)] [max_nesting_level=<int>] [group_search_filter=<string>] [group_attr_name=<string>] [max_ldap_referrals=<int>] [group_search_attribute=<string>] [group_search_subattribute=<string>] [auth_timeout=<int>] [nested_group_extraction=(false | true)] [group_name_identifier=<string>] [default_authentication_group=<string>] [bind_passwd=<stringx>] [bind_dn=<string>] [search_filter=<string>] [login_name=<string>] [base_dn=<string>] [address_type=<int>]
Parameters {#parameters-3 style="margin-left: 20px;"}¶
type
The type of LDAP server
This is a mandatory parameter.
name
Name of LDAP server
This is a mandatory parameter.
ip_address
The IP address of the LDAP server.
This is a mandatory parameter.
port
The port number on which the LDAP server is running
validate_ldap_server_certs
Validate LDAP Server Certificate
ldap_host_name
Host Name on the certificate from LDAP Server
sec_type
The communication type between the system and the LDAP server
subattribute_name
The Sub-Attribute name for group extraction from LDAP server
change_password
Enable change of the user
follow_referrals
Enable following LDAP referrals received from LDAP server
max_nesting_level
Number of levels at which group extraction is allowed
group_search_filter
String to be combined with the default LDAP group search string to form the search value
group_attr_name
The Attribute name for group extraction from the LDAP server
max_ldap_referrals
Maximum number of ldap referrals to follow
group_search_attribute
LDAP group search attribute. Used to determine to which groups a group belongs
group_search_subattribute
LDAP group search subattribute. Used to determine to which groups a group belongs.
auth_timeout
The maximum number of seconds the system will wait for a response from the LDAP server
nested_group_extraction
Enable Nested Group Extraction
group_name_identifier
Name that uniquely identifies a group in LDAP server
default_authentication_group
This is the default group
bind_passwd
The password used to bind to the LDAP server
bind_dn
The full distinguished name used to bind to the LDAP server
search_filter
The String to be combined with the default LDAP user search string to form the value
login_name
The name attribute used by the system to query the external LDAP server
base_dn
The base or node where the ldapsearch should start
address_type
Configuration Type. Values: 0: IPv4, 1: IPv6, -1: Hostname