/usr/bin/cull_idle_servers.py

This is an application.

Options
=======
The options below are convenience aliases to configurable class-options,
as listed in the "Equivalent to" description-line of the aliases.
To see all configurable class-options for some <cmd>, use:
    <cmd> --help-all

--generate-config
    Generate default config file.
    Equivalent to: [--IdleCuller.generate_config=True]
--api-page-size=<Int>
    Number of users to request per page, when using JupyterHub 2.0's paginated
    user list API. Default: user the server-side default configured page size.
    Default: 0
    Equivalent to: [--IdleCuller.api_page_size]
--concurrency=<Int>
    Limit the number of concurrent requests made to the Hub.

    Deleting a lot of users at the same time can slow down the Hub, so limit the
    number of API requests we have outstanding at any given time.
    Default: 10
    Equivalent to: [--IdleCuller.concurrency]
--config=<Unicode>
    Config file to load.
    Default: 'idle_culler_config.py'
    Equivalent to: [--IdleCuller.config_file]
--cull-admin-users=<Bool>
    Whether admin users should be culled (only if --cull-users=true).
    Default: True
    Equivalent to: [--IdleCuller.cull_admin_users]
--cull-default-servers=<Bool>
    Whether default servers should be culled (only if --cull-default-
    servers=true).
    Default: True
    Equivalent to: [--IdleCuller.cull_default_servers]
--cull-every=<Int>
    The interval (in seconds) for checking for idle servers to cull.
    Default: 0
    Equivalent to: [--IdleCuller.cull_every]
--cull-named-servers=<Bool>
    Whether named servers should be culled (only if --cull-named-servers=true).
    Default: True
    Equivalent to: [--IdleCuller.cull_named_servers]
--cull-users=<Bool>
    Cull users in addition to servers.

    This is for use in temporary-user cases such as tmpnb.
    Default: False
    Equivalent to: [--IdleCuller.cull_users]
--internal-certs-location=<Unicode>
    The location of generated internal-ssl certificates (only needed with --ssl-
    enabled=true).
    Default: 'internal-ssl'
    Equivalent to: [--IdleCuller.internal_certs_location]
--max-age=<Int>
    The maximum age (in seconds) of servers that should be culled even if they
    are active.",
    Default: 0
    Equivalent to: [--IdleCuller.max_age]
--remove-named-servers=<Bool>
    Remove named servers in addition to stopping them.

    This is useful for a BinderHub that uses authentication and named servers.
    Default: False
    Equivalent to: [--IdleCuller.remove_named_servers]
--ssl-enabled=<Bool>
    Whether the Jupyter API endpoint has TLS enabled.
    Default: False
    Equivalent to: [--IdleCuller.ssl_enabled]
--timeout=<Int>
    The idle timeout (in seconds).
    Default: 600
    Equivalent to: [--IdleCuller.timeout]
--url=<Unicode>
    The JupyterHub API URL.
    Default: None
    Equivalent to: [--IdleCuller.url]

To see all available configurables, use `--help-all`.