2.4. Misc

Home Prev	cOS Core 14.00.18 CLI Reference Guide	Next

2.4.1. clear

Clears the screen.

Description

Clears the screen.

Usage

clear

2.4.2. echo

Print text.

Description

Print text to the console.

Example 2.17. Hello World

echo Hello World

Usage

echo [<String>]...

Options

<String>: Text to print.

2.4.3. help

Show help for selected topic.

Description

The help system contains information about commands and configuration object types.

The fastest way to get help is to simply type help followed by the topic that you want help with. A topic can be for example a command name (e.g. set) or the name of a configuration object type (e.g. User).

When you don't know the name of what you are looking for you can specify the category of the wanted topic with the -category option and use tab-completion to display a list of matching topics.

Usage

help

List commands alphabetically.

help <Topic>

Display help about selected topic from any category.

help -category={COMMANDS | TYPES} [<Topic>]

Display help from a specific topic category.

Options

-category={COMMANDS | TYPES}: Topic category.
<Topic>: Help topic.

2.4.4. history

Dump history to screen.

Description

List recently typed commands that have been stored in the command history.

Usage

history

2.4.5. localconfiguration

Show management status and enable local configuration.

Description

Show management status, and regain local configuration control if the centralized management system has it.

If the centralized management system has taken control of the system, any single user may not do configuration changes to the system. In order to regain local configuration control to single users this command is used. Once local configuration is enabled, centralized management control can only be enabled by the centralized management system.

Usage

localconfiguration [-enable]

Options

-enable: Enable local configuration.

	Note
	Requires Administrator privileges.

2.4.6. logsnoop

Display and filter system log messages.

Description

The logsnoop command can be used to display system log events. The source of the log events can be MemLog, real-time or both MemLog followed by real-time logs.

MemLog searching will only be functioning if a LogReceiverMemory object has been configured.

Since the system log rate may be high, displaying real time logs must be done with some caution. For this purpose, it is possible to limit the real time log display rate.

When filtering for log messages to display, there are many parameters that can be filtered on. The most powerful filtering tool is the wildcard matching in which the charcter '*' is interpreted as none/many characters and '?' as any single character.

It should be noted that all log filtering will have a negative effect on system performance.

Example 2.18. Show log message having 'warning' followed by 'udp' somewhere in the message

:/> logsnoop -on -pattern=*warning*udp*

Example 2.19. Rate limit log flow to five logs per second

:/> logsnoop -on -rate=5

Example 2.20. Show logs from the memlog buffer

:/> logsnoop -on -source=memlog

Example 2.21. Show logs having a source IP value

:/> logsnoop -on -srcip=0.0.0.0/0

Example 2.22. Show logs having a severity of warning or higher

:/> logsnoop -on -severity=warning

Usage

logsnoop -on [-source={MEMLOG | REALTIME | BOTH}]
         [-category=<String>] [-logid=<Integer>] [-event=<String>]
         [-action={NONE | DROP | ALLOW | BLOCK | REJECT |
         <String>}] [-severity={EMERGENCY | ALERT | CRITICAL |
         ERROR | WARNING | NOTICE | INFO | DEBUG}]
         [-starttime=<DateTime>] [-endtime=<DateTime>]
         [-pattern=<String>] [-srcip=<IPAddress>]
         [-destip=<IPAddress>] [-srcport=<0...65535>]
         [-destport=<0...65535>] [-srcif=<Interface>]
         [-destif=<Interface>] [-ipproto={TCP | UDP | ICMP |
         <String>}] [-rate=<Integer>] [-num=<Integer>]

Start log session.

logsnoop -off

Stop log session.

logsnoop

Show log snoop status.

Options

-action={NONE | DROP | ALLOW | BLOCK | REJECT | <String>}: Log action to filter on.
-category=<String>: Log category to filter on.
-destif=<Interface>: Destination interface to filter on.
-destip=<IPAddress>: Destination IP address or network to filter on.
-destport=<0...65535>: Destination port to filter on.
-endtime=<DateTime>: End time of log snooping. Format: year-month-day [HH:MM:SS].
-event=<String>: Log event to filter on.
-ipproto={TCP | UDP | ICMP | <String>}: Protocol to filter on.
-logid=<Integer>: Numeric log ID to filter on.
-num=<Integer>: Total log limit, number of logs.
-off: Stop log session.
-on: Start log session.
-pattern=<String>: Free text filter supporting wildcards.
-rate=<Integer>: Rate limit, logs/sec. Only applicable for real time logs.
-severity={EMERGENCY | ALERT | CRITICAL | ERROR | WARNING | NOTICE | INFO | DEBUG}: Log severity to filter on. Equal or higher severity matches.
-source={MEMLOG | REALTIME | BOTH}: Log source. (Default: realtime)
-srcif=<Interface>: Source interface to filter on.
-srcip=<IPAddress>: Source IP address or network to filter on.
-srcport=<0...65535>: Source port to filter on.
-starttime=<DateTime>: Start time of log snooping. Format: year-month-day [HH:MM:SS].

	Note
	Requires Administrator privileges.

2.4.7. ls

Lists device data accessible by SCP.

Description

Lists device data which are available through SCP.

Example 2.23. Transfer script files to and from the device

Upload:   scp myscript user@fw-ip:script/myscript
Download: scp user@fw-ip:script/myscript ./myscript

In addition to the files listed it is possible to upload license, certificates and ssh public key files.

Example 2.24. Upload license data

scp licence.lic user@fw-ip:license.lic

Certificates and ssh client key objects are created if they do not exist.

Example 2.25. Upload certificate data

scp certificate.cer user@fw-ip:certificate/certificate_name
scp certificate.key user@fw-ip:certificate/certificate_name

Example 2.26. Upload ssh public key data

scp sshkey.pub user@fw-ip:sshpublickey/sshpublickey_name

Usage

Options

-long: Enable long listing format.
<File>: File to list.

2.4.8. script

Handle CLI scripts.

Description

Run, create, show, store or delete script files.

Script files are transferred to and from the device by the SCP protocol. On the device they are stored in the "/script" folder.

Example 2.27. Execute script

"script.sgs":
add IP4Address Name=$1 Address=$2 Comment="$0: \$100".
:/> script -execute -name=script.sgs ip_test 127.0.0.1
is executed as line: 
add IP4Address Name=ip_test Address=127.0.0.1 Comment="script.sgs: $100"

Usage

script -create [[<Category>] <Type> [<Identifier>]] [-name=<Name>]

Create configuration script from specified object, class or category.

script -execute [-verbose] [-force] [-quiet] -name=<Name>
       [<Parameters>]...

Execute script.

script -show [-all] [-name=<Name>]

Show script in console window.

script -store [-all] [-name=<Name>]

Store a script to persistent storage.

script -remove [-all] [-name=<Name>]

Remove script.

script

List script files.

Options

-all: Apply to all scripts.
-create: Create configuration script from specified object, class or category.
-execute: Execute script.
-force: Force script execution.
-name=<Name>: Name of script.
-quiet: Quiet script execution.
-remove: Remove script.
-show: Show script in console window.
-store: Store a script to persistent storage.
-verbose: Verbose mode.
<Category>: Category that groups object types.
<Identifier>: The property that identifies the configuration object. May not be applicable depending on the specified <Type>.
<Parameters>: List of input arguments.
<Type>: Type of configuration object to perform operation on.

	Note
	Requires Administrator privileges.