exp:expuserhygiene
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The counts of Users > Hygiene: accounts per state (disabled, unactivated, pending, locked, never signed in, inactive, orphaned, duplicate logins and addresses), each with the command that lists them
Usage
./console exp:expuserhygiene [options] php bin/php/expuserhygiene.php [options] ./console exp:user:hygiene [options]
Aliases
exp:user:hygiene
Help
The output of ./console help exp:expuserhygiene (the script run with --help), without the standard options:
Usage: bin/php/expuserhygiene.php [OPTION]... The state of the accounts at a glance Counts the accounts in each state of Users > Hygiene: all, enabled, disabled, unactivated, pending, locked, never signed in, inactive (not signed in for --days days), orphaned, and logins and e-mail addresses more than one account has; each with the exp:user:list command that lists them. Changes nothing. Run it before a clean-up, and from a monitoring job with --format=json. ./console exp:user:hygiene ./console exp:user:hygiene --days=365 --format=json Options: --days=VALUE With --state=inactive: not signed in for this many days (default 180) --format=VALUE text (default) or json (the machine output exp-user/1)
Options
| Option | Value | Description |
|---|---|---|
| --days | required | With --state=inactive: not signed in for this many days (default 180) |
| --format | required | text (default) or json (the machine output exp-user/1) |
Standard options
Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.
Source
bin/php/expuserhygiene.php, kernel/private/classes/commands/expuserhygiene.php
See also
Generated example: exp:expuserhygiene
Added to the reference for Exponential 6.0.15.
Contributors
- Graham Brookins Updated
Comments
Add a comment