Data Store Documentation Index
Command-Line Tool Reference Home

manage-account

Description
Examples
Subcommands
Arguments

Description

Access and alter password policy state properties for user entries.

Examples

Display all available password policy state information for the user 'uid=jdoe,ou=People,dc=example,dc=com':
manage-account get-all --hostname server.example.com --port 389 \
     --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --targetDN uid=jdoe,ou=People,dc=example,dc=com


Manually disable the account for the user 'uid=jdoe,ou=People,dc=example,dc=com':
manage-account set-account-is-disabled --hostname server.example.com --port 389 \
     --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --targetDN uid=jdoe,ou=People,dc=example,dc=com --operationValue true


Disable all accounts whose DNs are included in the input file 'dn-input-file.txt':
manage-account set-account-is-disabled --hostname server.example.com --port 389 \
     --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --dnInputFile dn-input-file.txt --operationValue true

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

Subcommands

clear-account-is-disabled
get-account-expiration-time
get-account-is-disabled
get-all
get-authentication-failure-times
get-grace-login-use-times
get-has-retired-password
get-last-login-time
get-password-changed-by-required-time
get-password-changed-time
get-password-expiration-warned-time
get-password-history
get-password-is-reset
get-password-policy-dn
get-password-retired-time
get-remaining-authentication-failure-count
get-remaining-grace-login-count
get-retired-password-expiration-time
get-seconds-until-account-expiration
get-seconds-until-authentication-failure-unlock
get-seconds-until-idle-lockout
get-seconds-until-password-expiration
get-seconds-until-password-expiration-warning
get-seconds-until-password-reset-lockout
get-seconds-until-required-change-time
purge-retired-password
set-account-is-disabled

clear-account-is-disabled

Clear account disabled state information from the user account


get-account-expiration-time

Display when the user account will expire


get-account-is-disabled

Display information about whether the user account has been administratively disabled


get-all

Display all password policy state information for the user


get-authentication-failure-times

Display the authentication failure times for the user


get-grace-login-use-times

Display the grace login use times for the user


get-has-retired-password

Determine whether the user has a valid retired password that may be used for authentication


get-last-login-time

Display the time that the user last authenticated to the server


get-password-changed-by-required-time

Display the required password change time with which the user last complied


get-password-changed-time

Display the time that the user's password was last changed


get-password-expiration-warned-time

Display the time that the user first received an expiration warning notice


get-password-history

Display password history state values for the user


get-password-is-reset

Display information about whether the user will be required to change his or her password on the next successful authentication


get-password-policy-dn

Display the DN of the password policy for the user


get-password-retired-time

Get the time the user's former password was retired


get-remaining-authentication-failure-count

Display the number of remaining authentication failures until the user's account is locked


get-remaining-grace-login-count

Display the number of grace logins remaining for the user


get-retired-password-expiration-time

Get the time the user's retired password will expire


get-seconds-until-account-expiration

Display the length of time in seconds until the user account expires


get-seconds-until-authentication-failure-unlock

Display the length of time in seconds until the authentication failure lockout expires


get-seconds-until-idle-lockout

Display the length of time in seconds until the user's account is locked because it has remained idle for too long


get-seconds-until-password-expiration

Display length of time in seconds until the user's password expires


get-seconds-until-password-expiration-warning

Display the length of time in seconds until the user should start receiving password expiration warning notices


get-seconds-until-password-reset-lockout

Display the length of time in seconds until the user's account is locked because the user failed to change the password in a timely manner after an administrative reset


get-seconds-until-required-change-time

Display the length of time in seconds that the user has to change his or her password before the account becomes locked


purge-retired-password

Purge any retired password from the user's entry


set-account-is-disabled

Specify whether the user account has been administratively disabled


set-account-is-disabled Arguments

-O {true|false}
--operationValue {true|false}

Description Enter 'true' to indicate that the account is disabled, or 'false' to indicate that it is not disabled
Allowed Values false
true
Required Yes
Multi-Valued No

Arguments

-V
--version

Description Display Data Store 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 Data Store hostname or IP address
Default Value 127.0.0.1
Required No
Multi-Valued No

-p {port}
--port {port}

Description Data Store port number
Lower Bound 1
Upper Bound 65535
Default Value 389
Required No
Multi-Valued No

-Z
--useSSL

Description Use SSL for secure communication with the server

-q
--useStartTLS

Description Use StartTLS to secure communication with the server

-D {bindDN}
--bindDN {bindDN}

Description The DN used to bind to the server
Required No
Multi-Valued No

-w {bindPassword}
--bindPassword {bindPassword}

Description The password used to bind to the server
Required No
Multi-Valued No

-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}

Description The path to the file containing the bind password
Required No
Multi-Valued No

-b {targetDN}
--targetDN {targetDN}

Description The DN of the user entry for which to get and set password policy state information
Required No
Multi-Valued No

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

Description SASL bind options
Required No
Multi-Valued Yes

-X
--trustAll

Description Trust all server SSL certificates

-K {keystorePath}
--keyStorePath {keystorePath}

Description Certificate keystore path
Required No
Multi-Valued No

-W {keystorePassword}
--keyStorePassword {keystorePassword}

Description Certificate keystore PIN
Required No
Multi-Valued No

-u {keystorePasswordFile}
--keyStorePasswordFile {keystorePasswordFile}

Description Certificate keystore PIN file
Required No
Multi-Valued No

-N {nickname}
--certNickname {nickname}

Description Nickname of the certificate for SSL client authentication
Required No
Multi-Valued No

-P {truststorePath}
--trustStorePath {truststorePath}

Description Certificate truststore path
Required No
Multi-Valued No

-T {truststorePassword}
--trustStorePassword {truststorePassword}

Description Certificate truststore PIN
Required No
Multi-Valued No

-U {path}
--trustStorePasswordFile {path}

Description Certificate truststore PIN file
Required No
Multi-Valued No

--dnInputFile {dnInputFile}

Description Path to an input file of DNs for use with this tool
Required No
Multi-Valued No

--help-subcommands

Description Display all available subcommands for use with this tool