11.3 Descrizione dettagliata dei comandi:
Nel paragrafo che segue vengono descritti dettagliatamente tutti i
comandi, in ordine alfabetico.
Nel titolo in alto, le voci descrittive hanno i seguenti significati:
• “
Lettura
” indica se il comando può restituire un valore in lettura (
√
)
oppure no (
×
),
• “
Scrittura
” è il livello utente minimo richiesto per l’accesso in scrittura
(se ammesso). Si noti che l’accesso in lettura non viene mai inibito
dal sistema di gestione utenti.
• “
Salvato
” indica se il comando eseguito è “salvato” (
√
) nella memoria
di configurazione permanente del WebGate e ricaricato con ogni
riavvio, oppure no (
×
).
Ciascun paragrafo è corredato da un esempio d’esecuzione da
consolle, in quanto più semplice da realizzare. Tutte le funzioni
possono però essere utilizzate, senza alcuna restrizione, anche in
pagine HTML. In questo caso, si noti che alcuni comandi non
restituiscono alcun valore visibile al browser, mentre nel caso di errori
può venire generata una “pagina di avvertenze” dedicata.
Inoltre, anche se non lo indicheremo per ogni singola funzione, qualora
il nome di una funzione venga scritto in modo errato o i valori non
rientrino nell’intervallo consentito, generalmente viene restituito un
messaggio di errore.
Infine, si noti che l’espressione “utente” indicata nei paragrafi che
seguono, si riferisce a qualsiasi operatore che accede al WebGate e
non al livello di accesso “user”, se non espressamente indicato.
AccessLevel
Descrizione
Lettura
Scrittura
Salvato
Restituisce il livello di accesso
utente attuale
√
×
×
Visualizza il livello di accesso utente attuale in formato numerico.
Questa funzione è disponibile sia tramite consolle che in HTML.
Vedi il capitolo
Gestione Utenti
per una descrizione del sistema di
gestione utenti.
Sintassi:
AccessLevel
Esempio consolle:
> AccessLevel
↵
249
> _
AccessLevelString
Descrizione
Lettura
Scrittura
Salvato
Restituisce la stringa descrittiva del
livello di accesso minimo per l’utente
attuale
√
×
×
Visualizza il livello di accesso utente attuale in forma di testo.
Vedi il capitolo
Gestione Utenti
per una descrizione del sistema di
gestione utenti.
Sintassi:
AccessLevelString
11.3 Detailed commands description:
In the following paragraphs all commands are described in detail, in
alphabetical order.
In the upper title, the description items have the following meanings:
• “
Read
” indicates whether the command can return a value when read
(
√
) or not (
×
),
• “
Write
” is the minimum user access level required for write access
(when allowed). Please note that read access is never restricted by
user management system instead.
• “
Saved”
indicates whether the command performed is “saved” (
√
) in
the WebGate persistent configuration memory and reloaded at every
reboot, or not (
×
).
Every paragraph is completed with a simple console example, since
this interface is the most straightforward to experiment with. However,
any function can be used, without restrictions, in HTML pages too. In
this last case, please note that some commands don’t make any output
value visible in the browser or, for some errors, a dedicated “warning
page” to be displayed can be generated.
Also if not indicated for each function, when a function name is
misspelled or values are outside the allowed ranges, generally an error
is returned.
As a final notice, please note that the expression “user” indicated in the
following paragraphs refers to any operator currently accessing the
WebGate and is not referred to the “user” level of access, if not
expressly written.
AccessLevel
Description
Read
Write
Saved
Return the current user access level
√
×
×
Displays the current user access level in numeric format.
This function is available either for console or HTML.
Please see chapter User Management for a description of user
management system.
Syntax:
AccessLevel
Console example:
> AccessLevel
↵
249
> _
AccessLevelString
Description
Read
Write
Saved
Return the minimum access level
descriptive string for the current user
√
×
×
Displays the current user access level in textual format.
Please see chapter
User Management
for a description of user
management system.
Syntax:
AccessLevelString
54
Manuale WebGate - cod. +030220230 rel. 1.0 - 16.09.2003
SWVersion
Return the WebGate software version
UpdateStatus
Return the last reboot update error code
WakeOn
Displays the time elapsed since the last WebGate reboot
Reserved
ClearConfig
This command is reserved and must not be used
DebugStrings
This command is reserved and must not be used
FlashFormat
This command is reserved and must not be used
LumpTest
This command is reserved and must not be used
Option
This command is reserved and must not be used