Get Commands
The dicfg get command returns information about the DiveLine server configuration and resources, such as the server authentication type and security level, user password requirements, and user and group settings. The command has the following sub-commands. Click a command name to display a description, including any additional command options.
| Command | Description |
|---|---|
| dicfg get alias | |
|
-source <name>
|
Returns the specified alias for the named source. |
| Command | Description |
|---|---|
| dicfg get auth_scheme | Returns the authentication type being used. |
| Command | Description |
|---|---|
| dicfg get integer -name auto_account_unlock_after | Returns the amount of time, in minutes, after which a locked user account is unlocked. |
| Command | Description |
|---|---|
| dicfg get boolean | |
|
-name <name>
|
Returns the Boolean value for the named item as it is set in the atlcfg.cfg file. For example, this command returns the TRUE or FALSE value of the password_reset_hide_URL item in the atlcfg.cfg file. dicfg -dataroot c:\DI_Solution\dl-dataroot get boolean -name password_reset_hide_URL |
| Command | Description |
|---|---|
| dicfg get default_search_path | Returns the default search path that the DiveLine server uses to locate models and lookup files that are not in the same directory as the referring markers and DivePlans. |
| Command | Description |
|---|---|
| dicfg get disable_after_failed_logins | Indicates whether accounts are set to be disabled after failed attempts to log on. |
| Command | Description |
|---|---|
| dicfg get disallow_username_in_password | Indicates whether a user name can be included in a user password. Applies to authentication type OWN only. |
| Command | Description |
|---|---|
| dicfg get diveline_port | Returns the port for the DiveLine service. |
| Command | Description |
|---|---|
| dicfg get group | |
|
-group <name>
|
|
|
-owner |
Returns the owner of the named group, if sub-administration is being used. |
|
-description |
Returns the description of the named group. |
| Command | Description |
|---|---|
| dicfg get integer | |
|
-name <name>
|
Returns the integer value for the named item as it is set in the atlcfg.cfg file. For example, this command returns the integer value of the client_keep_alive item in the atlcfg.cfg file. dicfg get integer -name client_keep_alive |
| Command | Description |
|---|---|
| dicfg get max_users | Returns the maximum number of concurrent users allowed on the DiveLine server. |
| Command | Description |
|---|---|
| dicfg get minimum_length | Returns the minimum number of characters allowed in a user password. Applies to authentication type OWN only. |
| Command | Description |
|---|---|
| dicfg get passwords_expire | Indicates whether passwords are set to expire. Applies to authentication type OWN only. |
| Command | Description |
|---|---|
| dicfg get require_digit | Indicates whether user passwords require a digit. Applies to authentication type OWN only. |
| Command | Description |
|---|---|
| dicfg get require_punctuation | Indicates whether user passwords require punctuation. Applies to authentication type OWN only. |
| Command | Description |
|---|---|
| dicfg get require_upper_and_lower_cases | Indicates whether user passwords require both upper and lower case characters. Applies to authentication type OWN only. |
| Command | Description |
|---|---|
| dicfg get restrict_previous_passwords | Returns the number of previous passwords a user can reuse. Applies to authentication type OWN only. |
| Command | Description |
|---|---|
| dicfg get security_level | Returns which security level the DiveLine server is running. Values are 0, 1, or 2. |
| Command | Description |
|---|---|
| dicfg get string | |
|
-name <name>
|
Returns the string value for the named item as it is set in the atlcfg.cfg file. For example, this command returns the address set for the broadcast_from_address item in the atlcfg.cfg file. dicfg get string -name broadcast_from_address |
| Command | Description |
|---|---|
| dicfg get top_level | Returns the top-level directory for the DiveLine server. |
| Command | Description |
|---|---|
| dicfg get user | |
|
-user<name>
|
|
|
-sp |
Returns the user search paths specified for the named user. |
|
-homedir |
Returns the home directory specified for the named user. |
|
-divebook |
Returns the default DiveBook specified for the named user. |
|
-admin_flag |
Indicates whether the named user is a DiveLine administrator. |
|
-administrator |
Indicates whether the named user is a DiveLine administrator. |
|
-owner |
Returns the owner of the named user, if sub-administration is being used. |
|
-apptpl |
Returns the application template specified for the named user. |
|
-description |
Returns the description of the named user. |
|
-fullname |
Returns the full name of the named user. |
|
-shortname |
Returns the short name of the named user. |
|
|
Returns the e-mail address of the named user. |
|
-can_change_password |
Indicates whether the named user is allowed to change their password. |
|
-requires_password_change |
Indicates whether the named user is required to change their password at next log on. |
|
-disabled |
Indicates whether the named user account is disabled. |
|
-locked_out |
Indicates whether the named user account is locked. |
|
-licensing |
Returns the licensing level that is set for the named user. If a user belongs to more than one category, a comma-delimited list is returned (Diver Platform only). |
|
-auth_override |
Indicates whether Set Authentication to OWN is checked for the named user. |
|
-disable_netdiver |
Indicates whether NetDiver is disabled for the named user. |
| Command | Description |
|---|---|
| dicfg get userstats |
Returns a table of user info: last login, last password change, last failed login attempt and number of failed attempts since last successful one. The format of the output is tab-delimited text with headers, one column per piece of data stored. Works in local mode only—does not work with the dicfg -remote flag. The last password change applies to authentication type OWN only. NOTE: Not all users defined in the configuration will be listed if no login attempt (successful or not) has been made since the last time the counters were reset. |
|
-p <port number>
|
Returns user info for the specified port. Default is 2130. For example, this command returns the user stats data for port 7000 as recorded in the config\userstats-7000.dat file. dicfg get userstats -p 7000 |
|
-node <node>
|
Returns user info for the specified node. The default is none—no clustering assumed. |
|
-user <name>
|
Returns user info for the single named user; otherwise all entries are included in the output. For example, this command returns just the user stats for jsmith on port 7100 as recorded in the config\userstats-7100.dat file. dicfg get userstats -p 7100 -user jsmith |
|
-q
|
Indicates suppression of information beyond the user info data. The quiet option suppresses the display of the name and location of the config file and any issues obtaining the data. |
The following sample get command accesses the remote DiveLine server and returns the authentication override setting for the user named "betty":
dicfg -remote admin:admin@localhost:6400 get user -user betty -auth_override