Personal tools

Nucli

From UntangleWiki

Jump to: navigation, search

The new Untangle command line interface.

What is the command to open the cli?

Just type nucli when in the Untangle console.

What can the command line configuration tool do?

Here's the help output from nucli.

Supported commands:
#X,%X,attack,backup,cleanup,close,exit,firewall,help,history,ips,jobs,loadrules,open,phish,pong,protofilter,quiet,quit,restore,router,rsh,ruby,save,servers,sh,source,spamblocker,spyware,uvm,verbose,virus,webfilter,with
> #X - switch effective server to server 'X' -- #3
> %X - display output of background job 'X' -- %1
> attack - send command to Attack Blocker -- enter 'attack help' for details.
> backup - backup Untangle server settings -- backup [to_disk|to_usb|to_file <filename>]
> cleanup - cleanup client resources, e.g., release stored job outputs, etc.
> close - close connection to server #X or host-name -- close #1
> exit - terminate immediately
> firewall - send command to Firewall -- enter 'firewall help' for details.
> help - display help information
> history - display command history, up to 50 events
> ips - send command to Intrusion Prevention System -- enter 'ips help' for details.
> jobs - list all background jobs currently running.
> loadrules - load rules into filter node from given file -- loadrules webfilter filename
> open - open connection to server -- open (host-name|ip):port [-l user]
> phish - send command to Phish Blocker -- enter 'phish help' for details.
> pong - test responsiveness of NUCLI server
> protofilter - send command to Protocol Filter -- enter 'protofilter help' for details.
> quiet - quiet all but alert level messages
> quit - terminate after user confirmation
> restore - restore Untangle server settings from local file -- restore <filename.backup>]
> router - send command to Router -- enter 'firewall help' for details.
> rsh - run command on remote server host -- rsh who
> ruby - send Ruby code to sever for execution -- ruby statement | file
> save - save output stored with job %X to filename -- save %3 myoutput.txt
> servers - list servers currently under management during this session.
> sh - run command on local host -- sh ls /dev
> source - source (i.e., run) the given script (use '.' as shortcut) -- source filename or . filename
> spamblocker - send command to Spam Blocker -- enter 'spamblocker help' for details.
> spyware - send command to Spyware Blocker -- enter 'spyware help' for details.
> uvm - send command to UVM -- enter 'uvm help' for details.
> verbose - set level of messages/chatter from client -- verbose [integer>=0]
> virus - send command to Virus Blocker -- enter 'virus help' for details.
> webfilter - send command to Web Filter -- enter 'webfilter help' for details.
> with - send multiple commands to servers, '##' or 'all' for all servers, '-i' for interactive, '-e' for echo -- with host-name #2 #4 -i -e
> !! - execute last/most recent command
> !number - execute historical command 'number' -- !5
> !prefix - execute most recent historical command beginning with 'prefix' -- !webfil
> Append '&' to any command to run it as a "background" job -- rsh who &
> %N - display output associated with command run as background job 'N' -- %1
> When entering a command, press [Tab] for command/word auto-completion.