Synchronization Server Documentation Index
Command-Line Tool Reference Home

authrate

Description
Examples
Arguments

Description

Perform repeated authentications against an LDAP directory server, where each authentication consists of a search to find a user followed by a bind to verify the credentials for that user.

Examples

Test authentication performance by searching randomly across a set of one million users located below 'dc=example,dc=com' with ten concurrent threads and performing simple binds with a password of 'password'. The searches will be performed anonymously.
authrate --hostname server.example.com --port 389 \
     --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --baseDN dc=example,dc=com --scope sub --filter "(uid=user.[1-1000000])" \
     --credentials password --numThreads 10

For examples and help with LDAP options see LDAP Option Help. For help with SASL authentication, see SASL Option Help

Arguments

-V
--version

Description Display Synchronization Server version information

-H
--help

Description Display general usage information

--help-ldap

Description Display help for using LDAP options

--help-sasl

Description Display help for using SASL options

--help-debug

Description Display help for using debug options
Advanced Yes

-h {host}
--hostname {host}

Description The IP address or resolvable name to use to connect to the directory server. If this is not provided, then a default value of 'localhost' will be used.
Default Value localhost
Required Yes
Multi-Valued Yes

-p {port}
--port {port}

Description The port to use to connect to the directory server. If this is not provided, then a default value of 389 will be used.
Default Value 389
Required Yes
Multi-Valued No

-D {dn}
--bindDN {dn}

Description The DN to use to bind to the directory server when performing simple authentication.
Required No
Multi-Valued No

-w {password}
--bindPassword {password}

Description The password to use to bind to the directory server when performing simple authentication or a password-based SASL mechanism.
Required No
Multi-Valued No

-j {path}
--bindPasswordFile {path}

Description The path to the file containing the password to use to bind to the directory server when performing simple authentication or a password-based SASL mechanism.
Required No
Multi-Valued No

-Z
--useSSL

Description Use SSL when communicating with the directory server.

-q
--useStartTLS

Description Use StartTLS when communicating with the directory server.

-X
--trustAll

Description Trust any certificate presented by the directory server.

-K {path}
--keyStorePath {path}

Description The path to the file to use as the key store for obtaining client certificates when communicating securely with the directory server.
Required No
Multi-Valued No

-W {password}
--keyStorePassword {password}

Description The password to use to access the key store contents.
Required No
Multi-Valued No

-u {path}
--keyStorePasswordFile {path}

Description The path to the file containing the password to use to access the key store contents.
Required No
Multi-Valued No

--keyStoreFormat {format}

Description The format (e.g., jks, jceks, pkcs12, etc.) for the key store file.
Required No
Multi-Valued No

-P {path}
--trustStorePath {path}

Description The path to the file to use as trust store when determining whether to trust a certificate presented by the directory server.
Required No
Multi-Valued No

-T {password}
--trustStorePassword {password}

Description The password to use to access the trust store contents.
Required No
Multi-Valued No

-U {path}
--trustStorePasswordFile {path}

Description The path to the file containing the password to use to access the trust store contents.
Required No
Multi-Valued No

--trustStoreFormat {format}

Description The format (e.g., jks, jceks, pkcs12, etc.) for the trust store file.
Required No
Multi-Valued No

-N {nickname}
--certNickname {nickname}

Description The nickname (alias) of the client certificate in the key store to present to the directory server for SSL client authentication.
Required No
Multi-Valued No

-o {name=value}
--saslOption {name=value}

Description A name-value pair providing information to use when performing SASL authentication.
Required No
Multi-Valued Yes

-b {dn}
--baseDN {dn}

Description The base DN to use for the searches. It may be a simple DN or a value pattern to specify a range of DNs (e.g., "uid=user.[1-1000],ou=People,dc=example,dc=com"). This must be provided.
Required Yes
Multi-Valued No

-s {scope}
--scope {scope}

Description The scope to use for the searches. It should be 'base', 'one', 'sub', or 'subord'. If this is not provided, a default scope of 'sub' will be used.
Allowed Values base
sub
one
subord
Default Value SUB
Required No
Multi-Valued No

-f {filter}
--filter {filter}

Description The filter to use for the searches. It may be a simple filter or a value pattern to specify a range of filters (e.g., "(uid=user.[1-1000])"). This must be provided.
Required Yes
Multi-Valued No

-A {name}
--attribute {name}

Description The name of an attribute to include in entries returned from the searches. Multiple attributes may be requested by providing this argument multiple times. If no return attributes are specified, then entries will be returned with all user attributes.
Required No
Multi-Valued Yes

-C {password}
--credentials {password}

Description The password to use when binding as the users returned from the searches. This must be provided.
Required Yes
Multi-Valued No

-a {authType}
--authType {authType}

Description The type of authentication to perform. Allowed values are: SIMPLE, CRAM-MD5, DIGEST-MD5, and PLAIN. If no value is provided, then SIMPLE authentication will be performed.
Default Value simple
Required Yes
Multi-Valued No

-t {num}
--numThreads {num}

Description The number of threads to use to perform the authentication processing. If this is not provided, then a default of one thread will be used.
Upper Bound 2147483647
Default Value 1
Required Yes
Multi-Valued No

-i {num}
--intervalDuration {num}

Description The length of time in seconds between output lines. If this is not provided, then a default interval of five seconds will be used.
Upper Bound 2147483647
Default Value 5
Required Yes
Multi-Valued No

-I {num}
--numIntervals {num}

Description The maximum number of intervals for which to run. If this is not provided, then the tool will run until it is interrupted.
Upper Bound 2147483647
Default Value 2147483647
Required Yes
Multi-Valued No

-r {auths-per-second}
--ratePerSecond {auths-per-second}

Description The target number of authorizations to perform per second. It is still necessary to specify a sufficient number of threads for achieving this rate. If this option is not provided, then the tool will run at the maximum rate for the specified number of threads.
Upper Bound 2147483647
Required No
Multi-Valued No

--warmUpIntervals {num}

Description The number of intervals to complete before beginning overall statistics collection. Specifying a nonzero number of warm-up intervals gives the client and server a chance to warm up without skewing performance results.
Upper Bound 2147483647
Default Value 0
Required Yes
Multi-Valued No

--timestampFormat {format}

Description Indicates the format to use for timestamps included in the output. A value of 'none' indicates that no timestamps should be included. A value of 'with-date' indicates that both the date and the time should be included. A value of 'without-date' indicates that only the time should be included.
Default Value none
Required Yes
Multi-Valued No

--suppressErrorResultCodes

Description Indicates that information about the result codes for failed operations should not be displayed.

-c
--csv

Description Generate output in CSV format rather than a display-friendly format

-R {value}
--randomSeed {value}

Description Specifies the seed to use for the random number generator.
Lower Bound -2147483648
Upper Bound 2147483647
Required No
Multi-Valued No