PREFERENCES

PREFERENCES

Description:

With this command the values for the preferences are communicated. The server uses the command to inform about defaults, the client uses the command to send the user selections.

Note that besides some general preferences, the syntax definition describes also per-NVT preferences and its special way of applying these.

Available preferences:

ntp_save_sessions

If set to "yes", the server will support server-side saving of scan sessions and the following commands will be available: SESSIONS_LIST, SESSION_DELETE and SESSION_RESTORE.

save_session

If set to "yes", the server will save the scan as a session.

save_empty_sessions

Only considered if save_session is set to "yes". If set to "yes" even empty scans will be saved as a session.

max_threads

test_file

ping_hosts

reverse_lookup

outside_firewall

host_expansion

port_range

max_hosts

save_knowledge_base

Activates KB saving when set to "yes"

only_test_hosts_whose_kb_we_have

Only scans host for which the KB is filled when set to "yes".

only_test_hosts_whose_kb_we_dont_have

Only scans host for which the KB is empty when set to "yes".

kb_restore

Restore the KB contents for tested hosts when when set to "yes".

kb_dont_replay_scanners

Don't run scanners in case kb_restore is set to "yes" and there is contents in the KB when set to "yes".

kb_dont_replay_info_gathering

Don't run gatherers in case kb_restore is set to "yes" and there is contents in the KB when set to "yes".

kb_dont_replay_attacks

Don't run attack scripts in case kb_restore is set to "yes" and there is contents in the KB when set to "yes".

kb_dont_replay_denials

Don't run DoS attack scripts in case kb_restore is set to "yes" and there is contents in the KB when set to "yes".

kb_max_age

This sets the maximum age (in seconds) of a KB until it gets disregarded.

timeout.<nvt_id> = <timeout>

Set the timeout <timeout> for NVT <nvt_id>. Timeout of "-1" means no specific timeout.

Only sent by CLIENT:

plugin_set

empty means all NVTs

ntp_opt_show_end

Tell server to send FINISHED messages

ntp_keep_communication_alive

Tell server to keep the connection even after a scan was finished.

ntp_short_status

Tell server send shorter STATUS message in order to save bandwidth.

Syntax:

SERVER <|> PREFERENCES <|>
pref_name <|> value
pref_name <|> value
pref_name <|> value
...
<|> SERVER

CLIENT <|> PREFERENCES <|>
pref_name <|> value
pref_name <|> value
pref_name <|> value
...
<|> CLIENT

For preference of individual NVTs these lines can occur inside the list:

nvt_name[pref_type]:pref_name <|> value

where

nvt_name

This references the NVT for which the preferences are set

pref_type

Defines the variable type of the preference which ultimately determines the widget type in the client GUI.

pref_name

This references the Preference and at the same time is used as the visible string for the user in the GUI.

value

The default value for this preference when sent by SERVER, the user selected value if send by CLIENT

and pref_type is one of these:

checkbox

value is "yes" or "no"

entry

value is a text string

password

value is a text string but should not be shown in GUI or in cleartext in local files

radio

value is a list of semicolon-separated options when sent by SERVER and only the user-selected option name when sent by CLIENT

file

value is "<none>" when sent by SERVER and a file path when sent by CLIENT. The client has to submit the file under the very same path name using the command ATTACHED_FILE.

PREFERENCES