ldapargs (metacp)
Synopsis
ldapargs help [operation | -verbose]
ldapargs operations
ldapargs modify
[-bindid bid]
{-default |
[-dereferencealias {ALWAYS | NEVER | SEARCHING | FINDING}]}
[-followreferral {TRUE | FALSE}]
[-sizelimit {limit | INFINITE}]
[-timelimit {limit | INFINITE}]}
ldapargs show [-bindid bid] [-pretty]
Purpose
A metacp object that manages the service controls for LDAP binds. The ldapargs object operations can only be issued for established LDAP binds.
Arguments
- operation
-
The name of the ldapargs operation for which to display help information.
Operations
ldapargs help
Returns help information about the ldapargs object and its operations. The syntax is as follows:
ldapargs help [operation | -verbose]
Options
- -verbose
-
Displays information about the ldapargs object.
Used without an argument or option, the ldapargs help command returns brief information about each ldapargs operation. Use the operation argument to return a description of the options associated with the operation you specify. Alternatively, you can use the -verbose option to return a description of the ldapargs object itself.
Example
ldapargs help
The output of the sample command is as follows:
|
|
|
|
|
|
|
|
ldapargs modify
Changes the service controls for LDAP binds. The syntax is as follows:
ldapargs modify
[-bindid bid]
{-default |
[-dereferencealias {ALWAYS | NEVER | SEARCHING | FINDING}]}
[-followreferral {TRUE | FALSE}]
[-sizelimit {limit | INFINITE}]
[-timelimit {limit | INFINITE}]}
Options
- -bindid bid
-
The name (bid) of the bind to be used. If this option is omitted, the default bind is used. (See the Bind Types and Bind IDs section in this chapter for details.)
- -default
-
Sets the service controls and options to the following values:
Dereference Alias
ALWAYS
Follow Referral
TRUE
Size Limit
INFINITE
Time Limit
INFINITE
Do not use this option with any other options except with the option -bindid.
- -dereferencealias {ALWAYS | NEVER | SEARCHING | FINDING}
-
Controls handling of aliases in directory operations. An alias is an entry that refers to another entry (the target). During directory operations, aliases can be replaced by the target entry (dereferenced). To control when this occurs, specify one of the following keywords:
-
ALWAYS
-
NEVER
-
SEARCHING - Aliases are dereferenced during an obj search operation but are not dereferenced when locating the base object of the search.
-
FINDING - Aliases are dereferenced when locating the base object of the search but are not dereferenced during the obj search operation.
The default value is ALWAYS.
-
- -followreferral {TRUE | FALSE}
-
Controls whether referrals returned by an obj search operation are followed automatically. The default value is TRUE.
- -sizelimit {limit | INFINITE}
-
Sets the maximum number of objects returned for obj list and obj search operations. Specify a non-negative integer or the keyword INFINITE. The default value is INFINITE.
- -timelimit {limit | INFINITE}
-
Sets the maximum elapsed time in seconds for completion of an obj list or obj search operation. If an obj list or obj search operation does not complete by the specified limit, the operation returns an arbitrary selection of results accumulated before exceeding the time limit. Specify a non-negative integer or the keyword INFINITE. The default value is INFINITE.
The ldapargs modify operation changes one or more service control settings to be used in all subsequent operations of the specified LDAP bind. Specify one or more of the options that correspond to the service controls you want to set. Alternatively, you can specify the -default option to set the control services to their default values.
Service control settings for a specific bind ID are lost when an obj unbind operation is issued for this bind ID. A subsequent obj bind operation resets the service controls to the default values for the specified bind ID. The service controls are not reset to the default values if the default bind is used. (See the obj bind operation for details.)
Examples
The following sample command performs the following tasks for the LDAP bind corresponding to the binding id hawkL3:
-
Limits the size of the results returned to 500 objects
-
Limits the amount of time to 30 seconds in which an operation can complete
ldapargs modify -bindid hawkL3 -sizelimit 500 -timelimit 30
The following sample command sets the service controls for the LDAP bind corresponding to the bind ID hawkL3 to the default values:
ldapargs modify -bindid haekL3 -default
ldapargs operations
Returns a list of operations that can be performed on the ldapargs object. The syntax is as follows:
ldapargs operations
The list of available operations is in alphabetical order except for help and operations, which are listed last.
Example
ldapargs operations
The output of the sample command is as follows:
modify show help operations
ldapargs show
Shows the service control settings currently in use for LDAP binds. The syntax is as follows:
ldapargs show [-bindid bid] [-pretty]
Options
- -bindid bid
-
The name (bid) of the bind to be used. If this option is omitted, the default bind is used. (See the Bind Types and Bind IDs section in this chapter for details.)
- -pretty
-
Displays the results of the operation in tabular format.
By default, the results of the ldapargs show operation are returned as a Tcl list. Use the -pretty option to display the results in a tabular, more readable format.
Example
bind -prot LDAPv3 ldapargs show -pretty
The output of the sample command is as follows:
Dereference Alias - ALWAYS Follow Referral - TRUE Size Limit - INFINITE Time Limit - INFINITE