Juniper Networks, Inc.
1133 Innovation Way
Sunnyvale, California 94089
USA
408-745-2000
www.juniper.net
Juniper Networks, the Juniper Networks logo, Juniper, and Junos are registered trademarks of Juniper Networks, Inc.
and/or its affiliates in the United States and other countries. All other trademarks may be property of their
respective owners.
Juniper Networks assumes no responsibility for any inaccuracies in this document. Juniper Networks reserves the
right to change, modify, transfer, or otherwise revise this publication without notice.
The information in this document is current as of the date on the title page.
YEAR 2000 NOTICE
Juniper Networks hardware and software products are Year 2000 compliant. Junos OS has no known time-related
limitations through the year 2038. However, the NTP application is known to have some difficulty in the year 2036.
END USER LICENSE AGREEMENT
The Juniper Networks product that is the subject of this technical document ation consists of (or is intended for
use with) Juniper Networks software. Use of such software is subject to the terms and conditions of the End User
License Agreement (“EULA”) posted at http://www.juniper.net/support/eula/. By downloading, installing or using
such software, you agree to the terms and conditions of that EULA.
Page 3
Draft for Review - FireEye Confidential - February 15, 2018
To obtain the most current version of all Juniper Networks® technical documentation, see the product
documentation page on the Juniper Networks website at http://www.juniper.net/techpubs/.
If the information in the latest release notes differs from the information in the documentation, follow the product
Release Notes. Juniper Networks Books publishes books by Juniper Networks engineers and subject matter
experts. These books go beyond the technical documentation to explore the nuances of network architecture,
deployment, and administration. The current list can be viewed at http://www.juniper.net/books.
Requesting Technical Support
Technical product support is available through the Juniper Networks Technical Assistance Center (JTAC). If you are
a customer with an active J-Care or Partner Support Service support contract, or are covered under warranty, and
need post-sales technical support, you can access our tools and resources online or open a case with JTAC.
• JTAC policies—For a complete understanding of our JTAC procedures and policies, review the JTAC User Guide
located at http://www.juniper.net/us/en/local/pdf/resource-guides/7100059-en.pdf.
• JTAC hours of operation—The JTAC centers have resources available 24 hours a day, 7 days a week, 365 days a
year.
Self-Help Online Tools and Resources
For quick and easy problem resolution, Juniper Networks has designed an online self service portal called the
Customer Support Center (CSC) that provides you with the following features:
This guide describes the commands that make up the command-line interface (CLI) of the Juniper ATP
Appliance.
This guide is intended for system administrators responsible for deploying, operating, and maintaining the Juniper
ATP Appliance.
Organization
This guide is organized as follows:
• Chapter 1, “Introduction”—Includes an overview of CLI usage, CLI Modes and information about how to
access the Juniper ATP Appliance Command Line Interface.
• Chapter 2, “All-in-One CLI Commands”—Provides information about system commands for updating the
product boot images, setting configurations, and defining system-level settings for Collector and
Detection Engine interfaces and network deployment services.
• Chapter 3, “Core/CM Server CLI Commands”—Provides information about commands available to the
Core and Central Manager for all hardware appliance, software appliance, and virtual appliance models,
including the commands used to manage Detection Engines and Juniper ATP Appliance system
configuration.
• Chapter 4, “Mac OS X Engine CLI Commands”—Provides information about Mac Mini Mac OS X Detection
Engine-specific commands for configuration and status monitoring.
• Chapter 5, “Traffic Collector CLI Commands”—Provides information about the Juniper ATP Appliance
Traffic Collector commands available for identifying, monitoring, and configuring distributed Collector
hardware, software and virtual appliances.
• Chapter 6, “Glossary of Terms”—Provides a set Juniper ATP Appliance-specific as well as cybersecurity
Enter yes to create a
new SSL certificate for
the Juniper ATP
Appliance Server Web
UI.
If you decline the selfsigned certificate by
entering no, be
prepared to install a
certificate authority
(CA) certificate.
Not applicable to
Collector.
Page 14
Juniper Advanced Threat Prevention Appliance
Configuration Wizard
Prompts
Enter the following server
attributes:
Is this a Central Manager device:
Device Name: (must be unique)
Device Description
Device Key PassPhrase
NOTE: Remember this
passphrase and use it for all
distributed devices!
Customer Response
from All-in-One
Enter Yes; the system
will auto-set IP
127.0.0.1 as the All-inOne IP address.
Enter the Juniper ATP
Appliance Collector
Host Name; this
identifies the Collector
in the Web UI.
Enter a device
Description
Enter a user-defined
PassPhrase to be used
to authenticate the
Core to the Central
Manager.
Customer Response
from Core
Enter Yes; the system
will auto-set IP
127.0.0.1 as the All-inOne IP address.
Enter a Juniper ATP
Appliance Mac Mini or
Core/CM Host Name;
this identifies the Mac
OS X or Core Engine in
the Web UI.
Enter a device
Description
Enter the same
PassPhrase used to
authenticate the Core
or Mac Mini to the
Central Manager.
or Mac Mini
Customer Response
from Collector
Enter No; the system
will request that you
enter the CM IP
address now.
Enter the Juniper ATP
Appliance Collector
Host Name; this
identifies the Collector
in the Web UI.
Enter a device
Description
Enter the same
PassPhrase used to
authenticate the
Collector to the Central
Manager.
Hardware, Software and Virtual Appliance Access via SSH
To access the Juniper ATP Appliance CLI over the management network:
1.Start a terminal window session and use the ssh command to access the appliance.
For example, if the IP address of the appliance is 10.1.1.2, enter the following command:
2.When prompted, enter your password. By default, the admin user name is admin and the password is
1JATP234.
3.To launch the configuration wizard, enter the command
wizard.
# wizard
See Configuration Wizard Command Prompt Progressions for steps.
CLI Help and Keyboard Shortcuts
To display Juniper ATP Appliance CLI help, type the command help to display CLI keys and auto-completion
usage.
For context-sensitive help, alternatively, enter a “?” to display either a list of possible command completions with
summaries, or the full syntax of the current command. A subsequent repeat of this key, when a command has
been resolved, will display a detailed reference, as described below.
• Enter “?” at the prompt to display a list of the available commands in the current mode.
• Enter “?” after you type a command to display its available options and parameters.
• Enter “?” after a partially typed keyword to display command matches for auto-completions
You can enter commands in abbreviated form if you enter enough characters to uniquely identify each keyword.
For example, the show interface command can be abbreviated as:
To identify a command’s minimum abbreviation, type a few characters then press Tab. When you have entered
enough characters, the keyword is completed.
The following table outlines the available CLI shortcuts.
Table 1-1 Keyboard Shortcuts
ActionShortcutDescription
Auto-Completion Enter, Tab
or Space
Key
Recall Ctrl+P or ↑Retrieve previous command from CLI history.
Ctrl+N or ↓Retrieve next command from CLI history.
Ctrl+L or
Ctrl+R
Delete Ctrl+DDelete character.
Ctrl+HDelete character before cursor (Backspace).
Ctrl+KDelete all characters from cursor to end of line.
Ctrl+U or
Ctrl+W
Cursor moveCtrl+AMove cursor to start of line.
Ctrl+BMove cursor back a single character.
Ctrl+EMove cursor to end of line.
Ctrl+FMove cursor forward a single character.
Character
Transpose
Ctrl+TTranspose character at the cursor with preceding character.
Completes a partial command during typing if enough
characters are typed to uniquely identify it.
Clear the screen or Redisplay the current command line.
Delete all characters or words on line.
Interrupt outputCtrl+CInterrupt presentation of the CLI output.
Replace!!Substitute the last command line
!NSubstitute the Nth command line (absolute as per 'history'
command)
!-NSubstitute the command line entered N lines before
(relative)
Exit mode or
logout
exitExit current mode or exit the CLI session.
SPECIAL CHARACTER REQUIREMENT
You must enclose non-alphabet characters in double quotes in CLI commands; for example:
Juniper ATP Appliance(server)# set passphrase “kfe$nd#$^S”
CLI Modes
The CLI commands that you can enter depend on your user privileges and the CLI command mode. User roles are
“admin” and “debugging.” The following table describes the CLI command mode.
Note that the prompt in each mode includes the host name of the Juniper ATP Appliance.
Table 1-2 Summary of CLI Modes
ModeDescriptionHow to Exit
Basic ModeMonitor system operation and issue basic system
commands. This is the default login mode. The following
prompt is displayed:
JATP#
CM ModeMonitor system history and upgrades from the Core or
vCore in cm (Central Manager) mode.
JATP_Hostname# cm
JATP_Hostname (cm)# ?
Core
Configuration
Mode
Collector
Configuration
Mode
Diagnosis
Packet
Capture,
Monitoring,
GSS Reporting
and
Configuration
Mode
To access Core configuration mode in the Core/CM, All-inOne, and Mac Mini, enter “core” in Basic mode. The prompt
changes to indicate the mode in parentheses:
JATP_Hostname# core
JATP_Hostname (core)# ?
Configure the Juniper ATP Appliance Collector (includes all
commands). To access Collector configuration mode,
enter “collector” in Basic mode. The prompt changes to
indicate the mode in parentheses:
Check Initial Setup, Diagnose, Monitor, Set GSS, and
Configure the Juniper ATP Appliance (includes all
commands). To access Diagnosis mode, enter
“diagnosis” in Basic mode. The prompt changes to
indicate the mode in parentheses:
Set up and monitor the system (includes all Basic
commands plus server-specific commands). To access
Server configuration mode, enter “server” in Basic mode.
The prompt changes to indicate the mode in parentheses:
JATP-Hostname# server
JATP-Hostname (server)# ?
Configure the system during installation and setup the
management network and connected Juniper ATP
Appliance components. To access wizard configuration
mode, enter “wizard” in Basic mode. The prompt changes
to indicate the mode in parentheses:
JATP-Hostname# wizard
JATP-Hostname (wizard)# ?
Enter exit to
leave server
mode.
Enter exit to
leave wizard
mode.
Page 17
This chapter describes the administration commands for a Juniper ATP Appliance All-in-One server appliance,
CHAPTER 2
All-in-One CLI Commands
software appliance or virtual appliance.
These commands are used to configure the Juniper ATP Appliance All-in-One appliance, manage configurations,
and set system-level settings for interfaces, network services, and SIEM integration.
NOTE You must enclose non-alphabet characters in double quotes in CLI commands.
Basic Mode Commands
Use general system commands to configure the appliance, view appliance history, enter other CLI modes, obtain
help with CLI syntax, and to exit the CLI session.
The general commands are:
• cm on page 12
• core on page 13
• collector on page 12
• diagnosis on page 14
• exit on page 14
• help on page 16
• history on page 17
• server on page 20
• wizard on page 35
Refer to the sections in this guide to review CM Mode, Collector Mode, Core Mode, Diagnosis Mode, Server Mode
and Wizard mode commands per device-- All-in-One, CoreCM, Traffic Collector and Mac OS X Detection Engine
on a Mac Mini.
Uses Secure Copy (SCP) to copy and transfer packet capture or traceback (crash)
data to a remote location, providing the same authentication and level of security
as an SSH transfer.
The copy traceback command, upon Customer Support's request, copies the
traceback files out of the box to a remote location.
See Also: diagnosis
Product(s) CLIAll-in-One | Collector | Core-CM | Mac OSX Engine
Mode(s)Diagnosis
[mode]; capture-start
copy capture <scp source_file_name
Syntax
username@destination_host:destination_folder> | traceback
{<tab> | ALL} <string URI as user@hostname:path
copy capture <scp remote filename_location>
Parameters
Sub-CommandsNone
Example
core
Table 2-5 core
Description
copy traceback <ALL | filename>
copy traceback <tab> [tab displays all available crash filenames]
The following example copies the file "Eth1.txt" from the local host to a remote
host:
DescriptionDisplays information about the CLI help system.
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)Basic | Core | Collector | Diagnosis | Server
Syntax
Parameters
Example
help
None
The following example shows some of the output of the help command.
CONTEXT SENSITIVE HELP
[?] - Display context sensitive help. This is either a list of
possible command completions with summaries, or the full syntax
of the current command. A subsequent repeat of this key, when a
command has been resolved, will display a detailed reference.
AUTO-COMPLETION
The following keys both perform auto-completion for the current
command line. If the command prefix is not unique then the bell
will ring and a subsequent repeat of the key will display
possible completions.
[enter] - Auto-completes, syntax-checks then executes a command.
If there is a syntax error then offending part of the command
line will be highlighted and explained.
[tab] - Auto-completes
[space] - Auto-completes, or if the command is already resolved
inserts a space.
If “<cr>” is shown, that means that what you have entered so
far is a complete command, and you may press Enter (carriage
return) to execute it.
Use ? to learn command parameters and option:
JATP (server)# show f?
firewall Show the firewall configuration settings
interface
JATP (server)# show firewall?
all Show the current iptables settings
whitelist Show the iptables whitelist settings
show firewall whitelist?
<cr>
show firewall whitelist
-c countNumber of echo requests to send. By default, pings ar
continuously until you press Ctrl+C.
-h hops Number of next hops between pings (default is 1).
stringIP address, hostname or interface name used to ping
device address.
ping
Table 2-12 ping
Sends ICMP (Internet Control Message Protocol) echo request packets to a
Description
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)Server
specified host name or IP address to verify that the destination is reachable over
the network.
Syntax
Parameters
Example
reboot
ping [-c count] [-h hops] [string]
The following example sends three echo requests to the device with the IP Address
10.10.10.1
<FireEye_name># ping -c 3 10.10.10.1
PING 10.10.10.1 (10.10.10.1) 56(84) bytes of data.
64 bytes from 10.10.10.1: icmp_req=1 ttl=64 time=0.314 ms
64 bytes from 10.10.10.1: icmp_req=2 ttl=64 time=0.277 ms
64 bytes from v: icmp_req=3 ttl=64 time=0.274 ms
Note: vCore for AWS
does not use the
following CLI
commands:
restore hostname
restore network
| network]
Whitelist rules rely on normal service shutdown to be backed up.Powering off a VM
directly will lose the whitelist state as rules cannot be saved in that case.
The following example restores the system.
JATP# restore
Example
server
Table 2-16 server
Description
Product(s) CLIAll-in-One | Collector | Core/CM | Mac Mini Mac OS X
Enables and disables the SSH-Honeypot feature for a Traffic Collector.
A honeypot can be deployed within a customer network to detect network activity
generated by malware attempting to infect or attack other machines in a local area
network. These attempted SSH logins can be used to supplement detection of
lateral spread.
Description
Product(s) CLIAll-in-One | Collector
Mode(s)collector
There are two parameters that can be set for a honeypot:
• Enable/disable a honeypot
• Set a Static IP (IP, mask, and gateway) or DHCP of a publicly addressable interface
See Also:
show honeypotcommand in show (collector mode)
(collector)# set honeypot ssh-honeypot enable dhcp
Adds a traffic filter rule where:
“RuleString” is the name of the rule
“DomainString” is the domain to filter out
“source-address” is the source IPv4 address or network
(CIDR)
“destination-address” is the destination IPv4 address or
network (CIDR)
“source-port” is the source port number (0-65535)
“destination-port” is the destination port number (0-65535)
“protocol” is the protocol type: either IP, TCP, UDP or HTTP
Table 2-19 set traffic-filter
Sets traffic filter rules to avoid analysis on a set of configured traffic, which cannot
be made retroactive; for example: any analysis skipped as a result of the filtering
Description
Product(s) CLIAll-in-One | Collector
Mode(s)collector
cannot be reversed. This command can be applied to an entire network/subnet/
CIDR range.
See Also: set (server mode)
set traffic-filter {add <rule_name> <domain> <source-
Sets an Inside or Outside data path proxy from collector mode.
Deploy Traffic Collectors in locations where the monitoring interface is (1) placed
“outside” between the proxy and the egress network for customer environments in
which the proxy supports XFF (X-Forwarded-For), or (2) [the more typical
deployment scenario], the Collector is placed between the proxy and the internal
network using FQDN (if available) to identify the threat source for all types of
incidents (“inside” proxy). When configured, the Juniper ATP Appliance Traffic
Collector will monitor all traffic and correctly identify source and destination hosts
for each link in the kill chain wherever the data allows for it.
Note that if the “X-Forwarded-For” header is provided in the HTTP request,
detection will identify threat targets when deployed outside of the proxy
Description
(customers can choose to disable the XFF feature in the proxy setting, if desired).
See Also: set (server mode)
(diagnosis mode);
NOTE The mitigation IP address of a CNC server is not be available for Inside
proxy deployments. When a Juniper ATP Appliance is deployed behind a proxy,
the Mitigation-> Firewall page in the Juniper ATP Appliance Central Manager
Web UI (which typically displays the CNC server IP address to mitigate) will be
empty. The destination IP address of any callback is made to the proxy server
ip address, so it is not relevant to display the proxy server IP address on the
Mitigation->Firewall page.
[“set proxy” command for management network]; set
Product(s) CLIAll-in-One | Collector
Mode(s)collector
set proxy inside {add <proxy IP address> <proxy port> |
remove <proxy IP address> <proxy port>
Syntax
set proxy outside {add <proxy IP address> | remove <proxy
IP address>
Parameters
The following example sets an inside data path proxy:
JATP (collector)# set proxy inside add 10.1.1.1 8080
Example
The following example sets an outside data path proxy:
dhcpEnables DHCP for the management or alternate-exhaust
interface.
addressSets the static IP address for the management (eth0) or
alternate-exhaust (eth2) interface,
netmaskSets the netmask for the management network or the
alternate-exhaust network.
gatewaySets the Gateway IP address for the management interfac
or the optional alternate-exhaust network.
set ip interface (server mode)
Table 2-23 set ip interface
Sets the management interface (eth0) and/or the alternate-exhaust interface
(eth2) for the Juniper ATP Appliance.
Description
Product(s) CLIAll-in-One | Core CM | Mac Mini OS X Detection Engine
Mode(s)server
Refer to the Operator’s Guide for information about configuring the optional
alternate analysis engine eth2 interface option (it moves CnC traffic during analysis
engine processing off the enterprise’s eth0 management network).
See Also: set (server mode)
shutdown
; set protocols (collector mode); show (core mode);
(server) # set ip interface management <dhcp | address |
netmask | gateway>
Syntax
(server) # set ip interface alternate-exhaust <address |
netmask | gateway>
Parameters
Example
The following example configures the management interface (eth0) for a Juniper
ATP Appliance Core device:
JATP (server)# set ip interface management address
Sets CLI timeout period in seconds (0 indicates
no timeout).
Sets the current date and time.
Sets the IP address of the Central Manager and
netmask using the slash notation; example:
AAA.BBB.CCC.DD/X
Enables remote SSH login “support” account or
localmode enable|/disable.
Sets DNS (or enables DHCP for DNS) for the management interface by default if interface is unspecified.
Backs up or flushes (clears) all current iptables
for a firewall, or adds, deletes or flushes the
current iptables whitelist-specific settings for the
firewall.
The “add” option adds an IP address to the
iptables outbound whitelist.
Configure the traffic threshold and checking interval for the Collector “monitored
traffic” health status.
Description
Product(s) CLIAll-in-One | Core CM
When the monitored traffic of a collector within the checking interval time is lower
than the threshold, a system health alert is generated. You can send an email
notification of the alert if email notifications of system health events are
configured.
CLI Command Reference Guide
Mode(s)Server, See Also: set (diagnosis mode)
set system-alert traffic <integer> time <interval>
Syntax
Parameters
NOTE Note that both "traffic" and "time" parameters are required in order to
set the threshold for both the minimum traffic and time.
traffic - the minimum traffic (in KB)
interval - the checking interval (in minutes)
JATP (server) # set system-alert traffic 100 time 30
This example sets the system alert such that, if the total monitored traffic of a
collector within the last 30 minutes dips lower than 100KB, then a system health
alert will be generated (and users will receive an email notification of the alert if
email notifications are configured for system health events).
Example
By default this alert is disabled, and users must set the minimum traffic and interval
in order to enable it. Also note that all bytes seen on Ethernet frames are counted in
the traffic.
The minimum interval for the "set system-alert traffic" time interval command is 10
minutes. If the minimum interval is set to less than 10 minutes, no alerts will be
triggered.
Shows current HTTP or SMB protocol parser settings
proxy {inside
|outside}
Shows Traffic Collector proxy for inside or outside
configurations.
honeypotShows the current honeypot configuration.
Table 2-27 show (collector mode)
CLI Command Reference Guide
Description
Product(s) CLIAll-in-One | Collector
Mode(s)Collector
Subcommands
Syntax
Parameters
Displays the Traffic Collector HOMENET settings and all configured subnets, as well
as current traffic filters and the current XFF status (enabled or disabled)
homenet | traffic-filter | proxy | honeypot
show
The following example displays the current Collector proxy inside settings:
collector02(collector)# show proxy inside
Proxy IPs: 10.1.1.1
The following example displays the current traffic filter:
collector02 (collector)# show traffic-filter
Example
Name: CustomRule2, Domain: headqtrs.example.com
The following example displays the current SMB protocol parser setting:
collector02 (collector)# show protocols
The following example displays the current honeypot configuration:
collector02 (collector)# show honeypot ssh-honeypot
show (collector mode)
Table 2-28 show (collector mode)
Description
Product(s) CLIAll-in-One | Collector
Mode(s)Collector
Display the currently selected traffic monitoring interface.
whitelistDisplays the name, hit count and the time of last
hit of a user configured whitelist.
Note that when a whitelist rule is deleted, it will be
removed from the list. Updates to existing rule are
not affected by the presence of the rule in the
output, but hit count could increment. Further,
more than one rule can be hit by a single incident.
alternate-exhaustinterface
Displays the status of the alternate exhaust
interface eth2.
show (core mode)
Table 2-1
Description
Product(s) CLIAll-in-One | Core CM | Mac Mini OS X Detection Engine
Mode(s)Core
Syntax
Parameters
Displays the guest image(s) status or whitelist statistics.
See Also: shutdown
; show (diagnostic mode)
show
The following example demonstrates the show images command usage:
JATP(core)# show images
The following example demonstrates the show whitelist command usage:
JATP(core)# show whitelist
JATP(core)# show whitelist
Example
Rule Name Hit Count Local Time of Last Hit
URI1 10 Wed Sep 2 18:16:55 2015
URI2 10 Wed Sep 2 18:16:55 2015
URI3 10 Wed Sep 2 18:16:55 2015
greatfilesarey 49 Wed Sep 2 18:20:00 2015
The following example shows how to get the alternate-exhaust interface (eth2)
status:
Display connected device statistics for Traffic
Collector, CoreCM, or Mac Mini Detection Engine
Secondary “slave core.”
protocol {web |
email}
Displays the session counts for network web or
email protocols.
objectsDisplays the current number of file objects.
loggingDisplays the currently-configured logging level.
See Also: set traffic-filter (collector mode) logging
log error tracebackDisplays only the tracebacks (if any) generated by
Juniper ATP Appliance OS process error logs. A
traceback is a stack of functions that were
executing when an error condition was
encountered.
log error last
<integer: number of
lines to display>
Displays n [1-1000] lines of the contents of the
common log file.
Example: show log error last 12
Table 2-29 show
CLI Command Reference Guide
Description
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)diagnosis
Syntax
Parameters
Sets the logging levels for Juniper ATP Appliance components from diagnosis mode.
See Also: shutdown
; show (core mode)
show
The following example displays the connected Traffic Collector status.
JATP(diagnosis)# show device collectorstatus
<cr>
JATP (diagnosis)# show device collectorstatus
WEB_COLLECTOR
=====================================================
====
IP : 10.2.9.68
Enabled : True
Last Seen : 2015-07-25 15:13:17.967000-07:00
Example
Install Date : 2015-06-25 19:03:38-07:00
=====================================================
====
IP : 10.2.20.3
Enabled : True
Last Seen : 2015-07-28 11:07:42.046000-07:00
Install Date : 2013-11-14 09:25:39-08:00
built-inUpdates the guest-image on the detection Engine.
Table 2-33 updateimage
Update or correct the guest-image OS profile used by the detection and analysis
Description
Product(s) CLIAll-in-One | Core-CM | Mac Mini OS X Detection Engine
Mode(s)Core
behavioral engine.
The updateimage command will update the guest images from the Juniper ATP
Appliance update servers or a USB drive attached to the Juniper ATP Appliance.
CLI Command Reference Guide
Syntax
Parameters
Example
wizard
Table 2-34 wizard
Description
updateimage
The following example performs a built-in profile update for the Core detection
engine.
JATP (core)# updateimage built-in
Installing image SC-XP-20150617.img...
Previous version of SC-XP-20150617.img exists.
Checking integrity...
Image SC-XP-20150617.img is already installed
Installing image SC-W7-20150521.img...
Previous version of SC-W7-20150521.img exists.
Checking integrity...
Image SC-W7-20150521.img is already installed
Enters the Configuration Wizard. For Configuration Wizard commands and
response, see “Configuration Wizard for the All-in-One Server” in the next section to
follow command prompts and recommended responses.
Product(s) CLIAll-in-One | Core/CM | Collector | Mac Mini Mac OS X
Mode(s)Basic
Syntax
ParametersNone
Example
wizard
The following command starts the configuration wizard.
Use DHCP to obtain the IP address and DNS
server address for the administrative interface
(Yes/No)?
Note: Only if your DHCP response is no,enter
the following information when prompted:
a. IP address (no CIDR format)
b. Netmask
c. Enter a gateway IP address for this
management (administrative) interface:
d. Enter primary DNS server IP address.
e. Do you have a secondary DNS Server
(Yes/No).
f. Do you want to enter the search
domains?
g. Enter the search domain (separate
multiple search domains by space):
Restart the administrative interface (Yes/No)?
Enter a valid hostname.Type a hostname when prompted; do not
[OPTIONAL]
If the system detects a Secondary Core with an
eth2 port, then the alternate CnC exhaust
option is displayed:
Use alternate-exhaust for the analysis engine
exhaust traffic (Yes/No)?
Enter IP address for the alternate-exhaust
(eth2) interface:
Enter netmask for the alternate-exhaust (eth2)
interface: (example: 255.255.0.0)
Enter gateway IP Address for the alternateexhaust (eth2) interface: (example:10.6.0.1)
Enter primary DNS server IP Address for the
alternate-exhaust (eth2) interface: (example:
8.8.8.8)
Do you have a secondary DNS server for the
alternate-exhaust (eth2) interface?
Do you want to enter the search domains for
the alternate-exhaust (eth2) interface?
Note: A complete network interface restart can
take more than 60 seconds
We strongly discourage the use of DHCP
addressing because it changes dynamically. A
static IP address is preferred.
Recommended: Respond with no:
a. Enter an IP address
b. Enter a netmask using the form
255.255.255.0.
c. Enter a gateway IP address.
d. Enter the DNS server IP address
e. If
yes enter the IP address of the secondary
DNS server.
f. Enter
specific domain.
g. Enter search domain(s) separated by spaces;
for example: example.com lan.com dom2.com
Enter
settings applied.
include the domain; for example: JuniperATP1
Refer to “Configuring an Alternate Analysis
Engine Interface” in the Juniper ATP Appliance
Operator’s Guide for more information.
Enter yes to configure an alternate eth2
interface.
Enter the IP address for the eth2 interface.
Enter the eth2 netmask.
Enter the gateway IP address.
Enter the primary DNS server IP Address for the
alternate-exhaust (eth2) interface.
Enter yes or no to confirm or deny an eth2
secondary DNS server.
Enter yes or no to indicate whether you want to
enter search domain.
yes if you want DNS lookups to use a
yes to restart with the new configuration
Regenerate the SSL self-signed certificate
(Yes/No)?
Enter yes to create a new SSL certificate for
the Juniper ATP Appliance Server Web UI.
Page 45
This chapter describes the commands for available for Juniper ATP Appliance Core/CM or vCore servers. These
CHAPTER 3
Core/CM Server CLI Commands
commands are used to configure devices and software, manage security events, and show system information
and status.
You must enclose non-alphabet characters in double quotes in CLI commands.
Basic Mode Commands
Use general system commands to configure the appliance, view appliance history, enter other CLI modes, obtain
help with CLI syntax, and to exit the CLI session.
The general commands are:
• cm on page 39
• core on page 40
• diagnosis on page 41
• exit on page 42
• help on page 43
• history on page 44
• server on page 48
• wizard on page 59
Refer to the respective sections in this guide to review Diagnosis Mode, CM Mode, Collector Mode and Server
Mode commands per product device.
Uses Secure Copy (SCP) to scp to copy and transfer packet capture or traceback
(crash) data to a remote location, providing the same authentication and level of
security as an SSH transfer.
See Also: diagnosis
Product(s) CLI
Mode(s)Diagnosis
All-in-One | Collector | Core | Mac OS X Detection Engine
copy capture <scp source_file_name
Syntax
username@destination_host:destination_folder> | traceback
all <string URI as user@hostname:path>
copy capture <scp remote filename_location>
Parameters
copy traceback all <path string>
copy traceback <tab> [tab displays all available crash
filenames]
Sub-CommandsNone
The following example copies the file "captureEth1.txt" from the local host to a
remote host:
DescriptionDisplays information about the CLI help system.
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)Basic | Core | CM | Collector | Diagnosis | Server
Syntax
Parameters
Example
help
None
The following example shows some of the output of the help command.
CONTEXT SENSITIVE HELP
[?] - Display context sensitive help. This is either a list of
possible command completions with summaries, or the full syntax
of the current command. A subsequent repeat of this key, when a
command has been resolved, will display a detailed reference.
AUTO-COMPLETION
The following keys both perform auto-completion for the current
command line. If the command prefix is not unique then the bell
will ring and a subsequent repeat of the key will display
possible completions.
[enter] - Auto-completes, syntax-checks then executes a command.
If there is a syntax error then offending part of the command
line will be highlighted and explained.
[tab] - Auto-completes
[space] - Auto-completes, or if the command is already resolved
inserts a space.
If “<cr>” is shown, that means that what you have entered so
far is a complete command, and you may press Enter (carriage
return) to execute it.
Use ? to learn command parameters and option:
JATP (server)# show f?
firewall Show the firewall configuration settings
interface
JATP (server)# show firewall?
all Show the current iptables settings
whitelist Show the iptables whitelist settings
show firewall whitelist?
<cr>
show firewall whitelist
-c countNumber of echo requests to send. By default, pings ar
continuously until you press Ctrl+C.
-h hops Number of next hops between pings (default is 1).
stringIP address, hostname or interface name used to ping
device address.
ping
Table 3-11 ping
Sends ICMP (Internet Control Message Protocol) echo request packets to a
Description
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)Server
specified host name or IP address to verify that the destination is reachable over
the network.
Syntax
Parameters
Example
reboot
ping [-c count] [-h hops] [string]
The following example sends three echo requests to the device with the IP Address
10.10.10.1
<FireEye_name>#
PING 10.10.10.1 (10.10.10.1) 56(84) bytes of data.
64 bytes from 10.10.10.1: icmp_req=1 ttl=64 time=0.314 ms
64 bytes from 10.10.10.1: icmp_req=2 ttl=64 time=0.277 ms
64 bytes from v: icmp_req=3 ttl=64 time=0.274 ms
Restores the default support password setting for SSH
remote login (set during initial installation per license).
See also (server)# set (server mode) support
firewall
{backup |
default}
Restores the firewall settings from either the previous
backup, or from the default factory settings.
Whitelist rules rely on normal service shutdown to be
backed up.Powering off a VM directly will lose the whitelist
state as rules cannot be saved in that case
hostname
Restores the system’s hostname to the factory default
hostname.
network
Restores the IP address and DNS settings to the
factory default settings.
WARNING: This command option removes the current
IP address and DNS settings, and reloads the default
values for these settings.
restore
Table 3-14 restore
DescriptionRestores the system configuration to the factory default settings.
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)Server
Syntax
Parameters
Note:vCore for AWS
does not use the
following CLI
commands:
restore hostname
restore network
DescriptionResets the Secondary Core UUID, if the virtual core is cloned.
Product(s) CLICore/CM (Virtual Core)
Mode(s)Core (for Virtual Core configurations)
Syntax
Sub-CommandsNone
Example
set id
The following example sets the Virtual Core appliance id:
hostname # core
hostname (core) # set id
<cr>
server
Table 3-16 server
DescriptionEnters the server configuration mode.
Product(s) CLIAll-in-One | Collector | Core/CM | Mac Mini Mac OS X
Mode(s)Basic
Syntax
server
exit; help; history; ifrestart; ping; reboot; restore; set
Sub-Commands
(server mode); show (server mode); traceroute; upgrade
Whitelist rules rely on normal service shutdown to be backed up. Powering off a VM
directly will lose the whitelist state as rules cannot be saved in that case.
The following example enters server configuration mode:
Example
hostname # server
hostname (server) # ?
set system-alert (server mode)
Table 3-17 set system-alert
Configure the traffic threshold and checking interval for the Collector “monitored
traffic” health status.
When the monitored traffic of a collector within the checking interval time is lower
than the threshold, a system health alert is generated. You can send an email
notification of the alert if email notifications of system health events are
configured.
; set (collector mode); show
Page 57
Table 3-17 set system-alert
CLI Command Reference Guide
set system-alert traffic <integer> time <interval>
Syntax
Parameters
Example
NOTE Note that both "traffic" and "time" parameters are required in order
to set the threshold for both the minimum traffic and time.
traffic - the minimum traffic (in KB)
interval - the checking interval (in minutes)
JATP (server) # set system-alert traffic 100 time 30
This example sets the system alert such that, if the total monitored traffic of a
collector within the last 30 minutes dips lower than 100KB, then a system health
alert will be generated (and users will receive an email notification of the alert if
email notifications are configured for system health events).
By default this alert is disabled, and users must set the minimum traffic and interval
in order to enable it. Also note that all bytes seen on Ethernet frames are counted in
the traffic.
The minimum interval for the "set system-alert traffic" time interval command is 10
minutes. If the minimum interval is set to less than 10 minutes, no alerts will be
triggered.
Backs up or flushes (clears) all current iptables
for a firewall, or adds, deletes or flushes the
current iptables whitelist-specific settings for the
firewall.
The “add” option adds an IP address to the
iptables outbound whitelist.
DescriptionChecks and reports on basic configuration settings and analysis pipeline setup.
Product(s) CLIAll-in-One | Core CM | Mac Mini OS X Detection Engine
Mode(s)diagnosis
Syntax
Parameters
Example
setupcheck {all | report | basic | analysis}
The following example checks all basic configuration settings as well as the
analysis pipeline:
JATP (diagnosis) # setupcheck all
Page 61
show (core mode)
imagesDisplays guest image update and status information.
whitelist Displays the name, hit count and the time of last hit of a user
configured whitelist.
Note that when a whitelist rule is deleted, it will be removed
from the list. Updates to existing rule are not affected by the
presence of the rule in the output, but hit count could
increment. Further, more than one rule can be hit by a single
incident.
alternateexhaustinterface
Displays the status of the alternate exhaust interface eth2.
Table 3-21 show
CLI Command Reference Guide
Description
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)Core
Syntax
Parameters
Displays the guest image(s) status or whitelist statistics.
See Also: show (server mode)
; show (diagnostic mode)
show
The following example demonstrates the show images command usage:
JATP(core)# show images
The following example demonstrates the show whitelist command usage:
JATP(core)# show whitelist
JATP(core)# show whitelist
Rule Name Hit Count Local Time of Last Hit
Display connected device statistics for Traffic Collector,
CoreCM, or Mac Mini Detection Engine Secondary “slave
core.”
protocol {web |
email}
Displays the session counts for network web or email
protocols.
objectsDisplays the current number of file objects.
loggingDisplays the currently-configured logging level.
See Also: set (diagnosis mode) logging
log error tracebackDisplays only the tracebacks (if any) generated by
Juniper ATP Appliance OS process error logs. A
traceback is a stack of functions that were executing
when an error condition was encountered.
log error last
<integer: number of
lines to display>
Displays n [1-1000] lines of the contents of the
common log file.
Example: show log error last 12
show (diagnosis mode)
Description
Product(s) CLI
Mode(s)
Syntax
Parameters
Displays diagnostics information.
See Also:show (server mode)
All-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
diagnosis
show
The following example displays the connected Traffic Collector status.
JATP(diagnosis)# show device collectorstatus
<cr>
JATP (diagnosis)# show device collectorstatus
WEB_COLLECTOR
=========================================================
IP : 10.2.9.68
Example
Enabled : True
Last Seen : 2014-07-25 15:13:17.967000-07:00
Install Date : 2014-06-25 19:03:38-07:00
=========================================================
IP : 10.2.20.3
Enabled : True
Show information about the management
(administrative) network interface eth0, or the
monitoring interface (eth1), or the
alternate-exhaust interface (eth2).
Show the IP address of the management
(administrative) interface eth0.
Results may show both private and public IP
addresses if the AWS vCore has a public IP.
Use DHCP to obtain the IP address and DNS
server address for the administrative interface
(Yes/No)?
Note: Only if your DHCP response is no,enter
the following information when prompted:
a. IP address (no CIDR format)
b. Netmask
c. Enter a gateway IP address for this
management (administrative) interface:
d. Enter primary DNS server IP address.
e. Do you have a secondary DNS Server
(Yes/No).
f. Do you want to enter the search
domains?
g. Enter the search domain (separate
multiple search domains by space):
Restart the administrative interface (Yes/No)?
We strongly discourage the use of DHCP
addressing because it changes dynamically. A
static IP address is preferred.
Recommended: Respond with no:
a. Enter an IP address
b. Enter a netmask using the form
255.255.255.0.
c. Enter a gateway IP address.
d. Enter the DNS server IP address
e. If yes, enter the IP address of the secondary
DNS server.
f. Enter yes if you want DNS lookups to use a
specific domain.
g. Enter search domain(s) separated by spaces;
for example: example.com lan.com dom2.com
Enter yes to restart with the new configuration
settings applied.
This chapter describes the CLI commands available for the Mac Mini Mac OS X “Secondary Core” detection
CHAPTER 4
Mac OS X Engine CLI
Commands
engine device. There is no Collector Mode on this device.
NOTE You must enclose non-alphabet characters in double quotes in CLI commands.
Basic Mode Commands
Use general system commands to configure the appliance, view appliance history, enter other CLI modes, obtain
help with CLI syntax, and to exit the CLI session.
The general commands are:
• core on page 66
• diagnosis on page 66
• exit on page 67
• help on page 68
• history on page 69
• server on page 72
• wizard on page 83
Refer to the respective chapters in this guide to review Collector Mode, Diagnosis Mode and Server Mode
commands per device-- All-in-One, Mac OS X Engine, Traffic Collector and CoreCM.
Starts packet capture as a means for diagnosing and debugging network traffic and
Description
Product(s) CLIAll-in-One | Collector | Core | Mac OS X Detection Engine
Mode(s)Diagnosis
obtaining stats (not part of the Collector traffic capture engine).
See Also: diagnosis
[mode]; copy
Syntax
Parameters<IP address> <interface_name>
Sub-CommandsNone
capture-start
The following example starts a packet capture process on interface eth1 for a
Juniper ATP Appliance with IP address 8.8.8.8:
hostname # diagnosis
Example
copy
Table 4-2 copy
Description
Product(s) CLI
hostname (diagnosis)# capture-start 8.8.8.8 eth1
NOTE Note: Address 8.8.8.8 need not be a Juniper ATP Appliance. It is just
a host that the capture filters on.
Uses Secure Copy (SCP) to scp to copy and transfer packet capture or traceback
(crash) data to a remote location, providing the same authentication and level of
security as an SSH transfer.
See Also: diagnosis
All-in-One | Collector | Core | Mac OS X Detection Engine
[mode]; capture-start
Mode(s)Diagnosis
copy capture <scp source_file_name
Syntax
username@destination_host:destination_folder> | traceback
all <string URI as user@hostname:path>
copy capture <scp remote filename_location>
Parameters
copy traceback all <path string>
copy traceback <tab>
Sub-CommandsNone
The following example copies the file "captureEth1.txt" from the local host to a
remote host:
DescriptionDisplays information about the CLI help system.
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)Basic | Server | Diagnosis
Syntax
ParametersNone
Example
help
The following example shows some of the output of the help command.
CONTEXT SENSITIVE HELP
[?] - Display context sensitive help. This is either a list of
possible command completions with summaries, or the full syntax
of the current command. A subsequent repeat of this key, when a
command has been resolved, will display a detailed reference.
AUTO-COMPLETION
The following keys both perform auto-completion for the current
command line. If the command prefix is not unique then the bell
will ring and a subsequent repeat of the key will display
possible completions.
[enter] - Auto-completes, syntax-checks then executes a command.
If there is a syntax error then offending part of the command
line will be highlighted and explained.
[tab] - Auto-completes
[space] - Auto-completes, or if the command is already resolved
inserts a space.
If “<cr>” is shown, that means that what you have entered so
far is a complete command, and you may press Enter (carriage
return) to execute it.
Use ? to learn command parameters and option:
JATP(server)# show f?
firewall Show the firewall configuration settings
interface
JATP(server)# show firewall?
all Show the current iptables settings
whitelist Show the iptables whitelist settings
show firewall whitelist?
<cr>
show firewall whitelist
Number of echo requests to send. By default, pings ar
continuously until you press Ctrl+C.
-h hops
Number of next hops between pings (default is 1).
string
IP address, hostname or interface name used to ping
device address.
ping
Table 4-10 ping
Sends ICMP (Internet Control Message Protocol) echo request packets to a
Description
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)Server
specified host name or IP address to verify that the destination is reachable over
the network.
Syntax
Parameters
Example
reboot
ping [-c count] [-h hops] [string]
The following example sends three echo requests to the device with the IP Address
10.10.10.1
<FireEye_name>#
PING 10.10.10.1 (10.10.10.1) 56(84) bytes of data.
64 bytes from 10.10.10.1: icmp_req=1 ttl=64 time=0.314 ms
64 bytes from 10.10.10.1: icmp_req=2 ttl=64 time=0.277 ms
64 bytes from v: icmp_req=3 ttl=64 time=0.274 ms
Restores the default support password setting for SSH
remote login (set during initial installation per license).
See also (server)# set (server mode) support
firewall
{backup |
default}
Restores the firewall settings from either the previous
backup, or from the default factory settings.
hostname
Restores the system’s hostname to the factory default
hostname.
network
Restores the IP address and DNS settings to the
factory default settings.
WARNING: This command option removes the current
IP address and DNS settings, and reloads the default
values for these settings.
restore
Table 4-13 restore
DescriptionRestores the system configuration to the factory default settings.
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)Server
Syntax
Parameters
NOTE: Whitelist rules
rely on normal service
shutdown to be backed
up.Powering off a VM
directly will lose the
whitelist state as rules
cannot be saved in that
case
NOTE: Whitelist rules
rely on normal service
shutdown for
backup.Powering off a
VM directly loses the
whitelist state as rules
cannot be saved in that
case.
Turn on or off the automatic product update feature.
Set CLI timeout period in seconds (0 = no timeout).
Sets the current date and time.
Sets the IP address of the Central Manager and
netmask using the slash notation; example:
AAA.BBB.CCC.DD/x
Enables remote SSH login “support” account or
localmode enable|/disable.
Sets the device key password; enter a string.
Sets the DNS servers (or enable DHCP for DNS)
for the management interface eth0.
Backs up or flushes (clears) all current iptables
for a firewall, or adds, deletes or flushes the
current iptables whitelist-specific settings for the
firewall.
The “add” option adds an IP address to the
iptables outbound whitelist.
timezone {US/
Eastern | US/
Central | US/
Mountain
uipassword
Sets the IP address, netmask, or default gateway,
or enables DHCP for the management or
alternate-exhaust interface.
Sets the Network Time Protocol (NTP) server.
Sets a new password for the CLI administrator.
Config, enable/disable, or remove “all” proxy configs,
or remove an HTTP-specific proxy server.
Tip: Config the proxy for “all” protocols first, and then
change HTTP proxy as needed.
Show the current timezone; example:
set timezone US/Pacific
TIP: set timezone <tab> shows options.
Sets a new admin password for CM Web UI access.
Example
The following example sets an ip address for the device management interface
eth0.
Displays guest image update and status information.
whitelist
Displays the name, hit count and the time of last hit of a user
configured whitelist.
Note that when a whitelist rule is deleted, it will be removed
from the list. Updates to existing rule are not affected by the
presence of the rule in the output, but hit count could
increment. Further, more than one rule can be hit by a single
incident.
alternateexhaustinterface
Displays the status of the alternate exhaust interface eth2.
setupcheck
Table 4-17 setupcheck
DescriptionChecks and reports on basic configuration settings and analysis pipeline setup.
Product(s) CLIAll-in-One | Core CM | Mac Mini OS X Detection Engine
Mode(s)diagnosis
Syntax
Parameters
Example
setupcheck {all | report | basic | analysis}
The following example checks all basic configuration settings as well as the
analysis pipeline:
JATP(diagnosis) # setupcheck all
show (core mode)
Table 4-18 show
Description
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)Core
Syntax
Displays the guest image(s) status.
See Also: show (server mode)
; show (diagnostic mode)
show
Parameters
Example
The following example demonstrates the show images command usage:
JATP(core)# show images
The following example shows how to get the alternate-exhaust interface (eth2)
status:
Show information about the management
(administrative) network interface eth0, or the
monitoring interface (eth1), or the
alternate-exhaust interface (eth2).
See Also:
Show the IP address of the management (administrative)
interface eth0.
Show the server name.
Show the Network Time Protocol (NTP) server settings.
Updates the guest-image on the Mac OSX Detection
“Secondary core.”.
Parameters
The following example performs a built-in Mac OS X profile update for the Mac
Mini-based Secondary core detection engine.
MAC2(core)# updateimage built-in
Installing image SC-OSX-20131003.img...
Previous version of SC-OSX-20131003.img exists. Checking
integrity...
Latest Image SC-OSX-20131003.img is already installed
Example
Installing image SC-XP-20140617.img...
Previous version of SC-XP-20140617.img exists. Checking
integrity...
Image SC-XP-20140617.img is already installed
Installing image SC-W7-20140521.img...
Previous version of SC-W7-20140521.img exists. Checking
integrity...
Image SC-W7-20140521.img is already installed
built-inUpdates the guest-image on the Mac OSX Detection
“secondary core.”.
Table 4-23 upgrade
Upgrade a configured Juniper ATP Appliance Mac OSX Mac Mini device. If the Mac
Mini has already been upgraded to Ubuntu 14.04, this upgrade command will not be
visible at the CLI because it will not be needed.
Please note that this command will only show up for existing customers that have
Description
Product(s) CLIMac Mini OS X Detection Engine
Mode(s)Core
Mac Mini devices configured as Juniper ATP Appliance Mac OSX detection engine
Secondary Cores (running Ubuntu 13.10). For new customers running Juniper ATP
Appliance Release 3.2.5, each Mac Mini device is shipped with the new Ubuntu
14.04 version already installed, so in this case, the upgrade command will again not
be available from the Juniper ATP Appliance Mac OSX Engine CLI.
CLI Command Reference Guide
Syntax
Parameters
Example
upgrade
The following example performs a built-in Mac OS X profile update for the Mac
Mini-based Secondary core detection engine.
MAC2(core)# upgrade
wizard
Table 4-24 wizard
Enters the Configuration Wizard. For Configuration Wizard commands and
Description
Product(s) CLIAll-in-One | Core/CM | Collector | Mac Mini Mac OS X
Mode(s)Basic
Syntax
ParametersNone
response, refer to “Configuration Wizard Command Prompt Responses” in the next
section to see command prompts and recommended responses.
wizard
The following command starts the configuration wizard.
Uses Secure Copy (SCP) to scp to copy and transfer packet capture or traceback
(crash) data to a remote location, providing the same authentication and level of
security as an SSH transfer.
Description
The copy traceback command, upon Customer Support's request, copies
the traceback files out of the box to a remote location.
See Also: diagnosis [mode]; capture-start
Product(s) CLIAll-in-One | Collector | Core-CM | Mac OSX Engine
Mode(s)Diagnosis
copy capture <scp source_file_name
Syntax
username@destination_host:destination_folder> | traceback
ALL <string URI as user@hostname:path>
copy capture <scp remote filename_location>
Parameters
copy traceback all <path string>
copy traceback <tab>
[tab displays all available crash filenames]
Sub-CommandsNone
The following example copies the file "captureEth1.txt" from the local host to a
remote host:
DescriptionDisplays information about the CLI help system.
Product(s) CLIAll-in-One | Collector | Core CM | Mac Mini OS X Detection Engine
Mode(s)Basic | Server | Collector | Diagnosis
Syntax
ParametersNone
help
The following example shows some of the output of the help command.
CONTEXT SENSITIVE HELP
[?] - Display context sensitive help. This is either a list of
possible command completions with summaries, or the full syntax
of the current command. A subsequent repeat of this key, when a
command has been resolved, will display a detailed reference.
AUTO-COMPLETION
The following keys both perform auto-completion for the current
command line. If the command prefix is not unique then the bell
will ring and a subsequent repeat of the key will display
possible completions.
[enter] - Auto-completes, syntax-checks then executes a command.
If there is a syntax error then offending part of the command
line will be highlighted and explained.
[tab] - Auto-completes
Example
[space] - Auto-completes, or if the command is already resolved
inserts a space.
If “<cr>” is shown, that means that what you have entered so
far is a complete command, and you may press Enter (carriage
return) to execute it.
Use ? to learn command parameters and option:
JATP (server)# show f?
firewall Show the firewall configuration settings
interface
JATP (server)# show firewall?
all Show the current iptables settings
whitelist Show the iptables whitelist settings
show firewall whitelist?
<cr>
show firewall whitelist