Atp Appliance Cli Reference
Atp Appliance Cli Reference
Published
2023-10-06
ii
Juniper Networks, the Juniper Networks logo, Juniper, and Junos are registered trademarks of Juniper Networks, Inc.
in the United States and other countries. All other trademarks, service marks, registered marks, or registered service
marks are the 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.
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.
The Juniper Networks product that is the subject of this technical documentation 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 https://support.juniper.net/support/eula/. By downloading, installing or using such
software, you agree to the terms and conditions of that EULA.
iii
Table of Contents
About This Guide | v
Organization | 2
Typographical Conventions | 3
Related Documentation | 4
Introduction | 4
CLI Modes | 13
CM Commands | 16
CM Commands | 60
iv
traceroute | 171
Use this guide to learn about the ATP Appliance CLI commands for system configuration and status
monitoring.
1 CHAPTER
Preface | 2
Introduction | 4
Preface
IN THIS SECTION
Organization | 2
Typographical Conventions | 3
Related Documentation | 4
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
• "Introduction" on page 4—Includes an overview of CLI usage, CLI Modes and information about
how to access the Juniper ATP Appliance Command Line Interface.
• "All-in-One CLI Commands" on page 15—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.
• "Core/CM Server CLI Commands" on page 59—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.
3
• "Mac OS X Engine CLI Commands" on page 105—Provides information about Mac Mini Mac OS X
Detection Engine-specific commands for configuration and status monitoring.
• "Traffic Collector CLI Commands" on page 137—Provides information about the Juniper ATP
Appliance Traffic Collector commands available for identifying, monitoring, and configuring
distributed Collector hardware, software and virtual appliances.
Typographical Conventions
This guide uses the following typographical conventions for special terms and instructions.
courier font Coding examples and text to be Enter the following command:
entered at the command prompt
Click server set dns
A left-mouse button click.
Click Download IVP to perform
endpoint infection verification.
Double-click A double-click of the left mouse Double-click the report name to open
button. in the integrated SIEM application.
Right-click A right mouse button click. Right-click on the icon to view its
properties.
< | > (text in angle brackets; Option for selection of required interfaces set stp <on | off >
items separated by the pipe parameter and/or value.
symbols)
4
[ ] (text in square brackets) Optional parameters and values, with show device alarm [cpu_util | paging]
selection options separated by the
or pipe symbol.
Related Documentation
• Juniper ATP Appliance Release Notes— Describes the latest release of the Juniper ATP Appliance
software.
• Juniper ATP Appliance Quick Start Guides— Quick Starts describe how to install and initially
configure a Juniper ATP Appliance; refer to the Quick Start for your device or model.
• Juniper ATP Appliance Operator’s Guide— The Operator’s Guide describes usage of all aspect of the
Juniper ATP Appliance All-in-One or distributed defense system.
• Juniper ATP Appliance CEF/SYSLOG Support for SIEM — This guide provides information about
Juniper ATP Appliance CEF and Syslog Logging for SIEM.
• Juniper ATP Appliance Safety and Regulatory Guide—Contains conformance and safety information
for Juniper ATP Appliances.
• Juniper ATP Appliance HTTP API Reference Guide— Provides Juniper ATP Appliance HTTP API
functions and information about usage.
Introduction
IN THIS SECTION
CLI Modes | 13
This chapter explains how to use the Juniper ATP Appliance command line interface (CLI) to configure
and administer a Juniper ATP Appliance.
IN THIS SECTION
1. Connect the end of the keyboard cable to any of the USB ports on the back panel of the appliance.
2. Connect the end of the video monitor cable to the VGA port on the back panel of the appliance.
3. At the CLI prompt, enter your username and password. By default, the admin user name is admin and
the password is 1JATP234.
Be sure to change the default password for the admin account after initial setup; the password must
be at least 8 characters in length.
IN THIS SECTION
NOTE: Enter CTRL-C to exit the Configuration Wizard at any time. If you exit without completing
the configuration, you will be prompted again whether to run the Configuration Wizard.
You may also rerun the Configuration Wizard at any time with the CLI command wizard.
Configuration Wizard Customer Response from Customer Response from Customer Response
Prompts All-in-One Core or Mac Mini from Collector
7
Use DHCP to obtain the We strongly discourage We strongly discourage We strongly discourage
IP address and DNS the use of DHCP the use of DHCP the use of DHCP
server address for the addressing because it addressing because it addressing because it
administrative interface changes dynamically. A changes dynamically. A changes dynamically. A
(Yes/No)? static IP address is static IP address is static IP address is
preferred. preferred. preferred.
NOTE: Only if your DHCP
response is no,enter the Recommended: Recommended: Recommended:
following information
when prompted: Respond with no: Respond with no: Respond with no:
Enter a valid hostname Type a hostname when Type a hostname when Type a hostname when
(enter a unique name) prompted; do not include prompted; do not include prompted; do not
the domain; for example: the domain; for example: include the domain; for
NOTE: Only alpha- example:
numeric characters and juniperatp1 juniperatp1
hyphens (in the middle of juniperatp1
the hostname) are
allowed.
9
Enter IP address for the Enter the IP address for Enter the IP address for
alternate-exhaust (eth2) the eth2 interface. the eth2 interface.
interface:
Enter the eth2 netmask. Enter the eth2 netmask.
Enter netmask for the
Enter the gateway IP Enter the gateway IP
alternate-exhaust (eth2)
address. address.
interface: (example:
255.255.0.0) Enter the primary DNS Enter the primary DNS
server IP Address for the server IP Address for the
Enter gateway IP Address
alternate-exhaust (eth2) alternate-exhaust (eth2)
for the alternate-exhaust
interface. interface.
(eth2) interface:
(example:10.6.0.1) Enter yes or no to confirm Enter yes or no to confirm
or deny an eth2 secondary or deny an eth2 secondary
Enter primary DNS server
DNS server. DNS server.
IP Address for the
alternateexhaust (eth2) Enter yes or no to indicate Enter yes or no to indicate
interface: (example: whether you want to enter whether you want to enter
8.8.8.8) search domain. search domain.
NOTE: A complete
network interface restart
can take more than 60
seconds
10
Regenerate the SSL self- Enter yes to create a new Enter yes to create a new Not applicable to
signed certificate (Yes/ SSL certificate for the SSL certificate for the Collector.
No)? Juniper ATP Appliance Juniper ATP Appliance
Server Web UI. Server Web UI.
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:
xssh mailto:[email protected]
2. When prompted, enter your password. By default, the admin user name is admin and the password is
1JATP234.
# wizard
IN THIS SECTION
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:
sh in
To identify a command’s minimum abbreviation, type a few characters then press Tab. When you have
entered enough characters, the keyword is completed.
Exit mode or logout exit Exit current mode or exit the CLI
session.
You must enclose non-alphabet characters in double quotes in CLI commands; for example:
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.
Basic Mode Monitor system operation and issue basic system commands. This Enter exit to log out
is the default login mode. The following prompt is displayed: of the CLI.
JATP#
CM Mode Monitor system history and upgrades from the Core or vCore in Enter exit to leave
cm (Central Manager) mode. cm mode.
JATP_Hostname# cm
JATP_Hostname (cm)# ?
14
Core Configuration To access Core configuration mode in the Core/CM, All-in- One, Enter exit to leave
Mode and Mac Mini, enter “core” in Basic mode. The prompt changes to server mode.
indicate the mode in parentheses:
JATP_Hostname# core
JATP_Hostname (core)# ?
Collector Configure the Juniper ATP Appliance Collector (includes all Enter exit to leave
Configuration Mode commands). To access Collector configuration mode, enter server mode.
“collector” in Basic mode. The prompt changes to indicate the
mode in parentheses:
JATP_Hostname# collector
JATP_Hostname (collector)# ?
Diagnosis Packet Check Initial Setup, Diagnose, Monitor, Set GSS, and Configure the Enter exit to leave
Capture, Juniper ATP Appliance (includes all commands). To access diagnosis mode.
Monitoring, GSS Diagnosis mode, enter “diagnosis” in Basic mode. The prompt
Reporting and changes to indicate the mode in parentheses:
Configuration Mode
JATP_Hostname# diagnosis
JATP_Hostname (diagnosis)# ?
Server Set up and monitor the system (includes all Basic commands plus Enter exit to leave
Configuration Mode server-specific commands). To access Server configuration mode, server mode.
enter “server” in Basic mode. The prompt changes to indicate the
mode in parentheses:
JATP-Hostname# server
JATP-Hostname (server)# ?
Wizard Configure the system during installation and setup the Enter exit to leave
Configuration Mode management network and connected Juniper ATP Appliance wizard mode.
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)# ?
15
SEE ALSO
IN THIS SECTION
CM Commands | 16
This chapter describes the administration commands for a Juniper ATP Appliance All-in-One server
appliance, 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.
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.
• "cm" on page 20
• "core" on page 23
• "collector" on page 21
• "diagnosis" on page 23
• "exit" on page 24
• "help" on page 26
• "history" on page 27
• "server" on page 34
• "wizard" on page 56
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.
CM Commands
• "exit" on page 24
• "help" on page 26
• "history" on page 27
• "upgrade" on page 55
• "exit" on page 24
• "help" on page 26
• "history" on page 27
• "updateimage" on page 55
17
• "exit" on page 24
• "help" on page 26
• "history" on page 27
• "ifrestart" on page 28
• "ping" on page 29
• "reboot" on page 30
• "restart" on page 31
• "restore" on page 32
• "restore" on page 32
• "shutdown" on page 53
• "shutdown" on page 53
• "traceroute" on page 54
• "exit" on page 24
• "help" on page 26
• "history" on page 27
• "capture-start" on page 20
• "copy" on page 22
• "exit" on page 24
• "gssreport" on page 25
• "help" on page 26
• "history" on page 27
• "setupcheck" on page 47
IN THIS SECTION
capture-start | 20
cm | 20
collector | 21
copy | 22
core | 23
diagnosis | 23
exit | 24
gssreport | 25
help | 26
19
history | 27
ifrestart | 28
ping | 29
reboot | 30
restart | 31
restore | 32
server | 34
setupcheck | 47
shutdown | 53
traceroute | 54
upgrade | 55
updateimage | 55
wizard | 56
20
capture-start
Table 3: capture-start
Mode(s) Diagnosis
Syntax capture-start
Sub-Commands None
hostname # diagnosis
cm
Table 4: cm
Mode(s) Basic
Syntax cm
Parameters None
hostname # cm
hostname (cm)#
collector
Table 5: collector
Mode(s) Basic
Syntax collector
Parameters None
Sub-Commands ;;;;
hostname # collector
hostname (collector)# ?
22
copy
Table 6: copy
Description 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.
Mode(s) Diagnosis
Sub-Commands None
Example The following example copies the file "Eth1.txt" from the local host to a
remote host:
mailto:[email protected]:/some/remote/directory
23
core
Table 7: core
Mode(s) Basic
Syntax core
Parameters None
hostname # core
hostname (core)#
diagnosis
Table 8: diagnosis
Mode(s) Basic
Syntax diagnosis
24
Parameters None
Sub-Commands ;;;;;;;;;
Example The following example enters diagnosis configuration and status check
mode:
hostname # diagnosis
hostname (diagnosis)# ?
exit
Table 9: exit
Syntax exit
Parameters None
JATP#
JATP# exit
25
gssreport
Description Use the gssreport command to submit reports to Juniper Global Security
Services (GSS), and to display the status of the current GSS report.
Mode(s) diagnosis
Sub-Commands None
Example The following examples display the status of a GSS report submission:
hostname # diagnosis
hostname (diagnosis)# gssreport submit
Successfully started GSS report
help
Syntax help
Parameters None
27
Example The following example shows some of the output of the help command.
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.
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.
history
Syntax
history
Parameters None
Example The following examples returns command line history for the current CLI
session.
ifrestart
Description Restarts the interface driver and services using the interface.
Mode(s) Server
Syntax
ifrestart eth0 | eth1
Parameters
eth0 Restarts the management network administra interface.
Example The following example restarts the eth0 interface for the management
network.
ping
Description Sends ICMP (Internet Control Message Protocol) echo request packets to a
specified host name or IP address to verify that the destination is reachable
over the network.
Mode(s) Server
Parameters
-ccount Number of echo requests to send. By default,
pings ar continuously until you press Ctrl+C.
Example The following example sends three echo requests to the device with the IP
Address 10.10.10.1
reboot
Mode(s) Server
Syntax reboot
Parameters None
hostname# reboot
31
restart
Mode(s) Server
Parameters
all Restarts all Juniper ATP Appliance services.
JATP# restart cm
restore
Description Restores the system configuration to the factory default settings. This will
only reset the password to default temporarily.
33
Mode(s) server
Parameters
support Restores the default support password setting
NOTE: vCore for AWS does not remote login (set during initial installation per l See
use the following CLI commands: also (server)# "set (server mode)" on page 44
restore hostname restore network
JATP# restore
This next example restores the SSH login “support” password to the
default
server
See Also:
Mode(s) Basic
Syntax server
Sub-Commands ;;;;;;;;
hostname # server
hostname (server) # ?
35
Description Enables and disables the SSH-Honeypot feature for a Traffic Collector.
• Enable/disable a honeypot
Mode(s) collector
Syntax
(collector)# set honeypot ssh-honeypot enable dhcp
Example The following example enables the SMB parser for lateral detections:
Mode(s) collector
Syntax
# set traffic-monitoring-ifc 1gb_ifc
Description 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
cannot be reversed. This command can be applied to an entire network/subnet/
CIDR range.
Mode(s) collector
37
Syntax
set traffic-filter {add <rule_name> <domain> <sourceaddress> <destination-
address> <source-port> <destination-port> <protocol> | remove <rule_name>}
Parameters
Adds a traffic filter rule where:
traffic-filter add
Example The following example add a traffic filter rule to the Traffic Collector.
Description Enables and disables the HTTP or SMB parser for a Traffic Collector.
Mode(s) collector
Syntax
(collector)# set protocols {http [on|off] | smb [on|off]}
Example The following example enables the SMB parser for lateral detections:
Description Sets an Inside or Outside data path proxy from collector mode.
Mode(s) collector
Syntax set proxy inside {add <proxy IP address> <proxy port> | remove <proxy IP
address> <proxy port>
Parameters
inside Sets the inside proxy IP addresses
Description Sets the logging levels for Juniper ATP Appliance components from
diagnosis mode.
Mode(s) diagnosis
Parameters
all Sets logging for all Juniper ATP Appliance
components.
Example The following example sets the default logging level for all Juniper ATP
Appliance components.
Description Change the appliance type at any time. For example, change from All-In-
One to Core/CM. Note that if you change the appliance type after the
initial installation, all data files related to the current type are lost and
you must set up the appliance as you would a fresh box.
Mode(s) server
42
Syntax
jatp:AIO#(server)# set appliance-type core-cm
Parameters
all-in-one
core-cm
email-collector
traffic-collector
Example The following example changes the form factor of the appliance from all-
in-one (the default) to core-cm:
See Also:;;;
Mode(s) server
Syntax
(server) # set ip interface management <dhcp | address | netmask |
gateway>
Parameters
dhcp Enables DHCP for the management or alternate-
exhaust interface.
Example The following example configures the management interface (eth0) for a
Juniper ATP Appliance Core device:
Syntax
set [autoupdate {on | off} | cli timeout secs | clock | cm address |
cysupport {enable | disable} localmode {enable | disable}| passphrase
string | dns | firewall {all <backup | flush> | whitelist} | hostname
string | ip interface {management | alternate-exhaust}| ntpserver |
password | proxy {config | enabled | remove} | timezone string |
uipassword]
Parameters Note: vCore for AWS does not use the following CLI commands:
set hostname
Description 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.
Syntax
set system-alert traffic <integer> time <interval>
NOTE: Note that both "traffic" and "time" parameters are required in order
to set the threshold for both the minimum traffic and time.
47
Parameters
- the minimum traffic (in KB)
traffic
Example
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.
setupcheck
Description Checks and reports on basic configuration settings and analysis pipeline
setup.
Mode(s) diagnosis
Syntax
setupcheck {all | report | basic | analysis}
48
Parameters
Checks both basic settings and analysis
all pipelin
Example The following example checks all basic configuration settings as well as
the analysis pipeline:
Description Displays the Traffic Collector HOMENET settings and all configured
subnets, as well as current traffic filters and the current XFF status (enabled
or disabled)
Mode(s) Collector
Subcommands
homenet | traffic-filter | proxy | honeypot
Syntax show
49
Parameters
Shows all traffic filter rules.
traffic-filter
Example The following example displays the current Collector proxy inside settings:
The following example displays the current SMB protocol parser setting:
Mode(s) Collector
Syntax
collector02 (collector)#ow traffic-monitoring-ifc-type
Mode(s) Core
Syntax show
Parameters
images Displays guest image update and status information.
whitelist Displays the name, hit count and the time of last hit of a
user configured allowlist.
Example The following example demonstrates the show images command usage:
Description Sets the logging levels for Juniper ATP Appliance components from
diagnosis mode.
Mode(s) diagnosis
Syntax show
Parameters
device Display connected device statistics for Traffic
{collectorstatus | Collector, CoreCM, or Mac Mini Detection Engine
| corestatus | Secondary “backup core.”
slavecorestatus}
See Also:
Example The following example displays the connected Traffic Collector status.
IP : 10.2.9.68
Enabled : True
Last Seen : 2015-07-25 15:13:17.967000-07:00
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
shutdown
Mode(s) Server
Syntax shutdown
54
Parameters None
JATP# shutdown
traceroute
Syntax traceroute
Parameters
-h unsigned integer Specifies the number of hops
upgrade
Description Upgrade Juniper ATP Appliance software for the Core/CM device or
vCore, and all connected physical or virtual devices.
Mode(s) cm
Syntax
upgrade <URI as user@hostname:path>
Parameters
<String_URI> Specifies the software packages to copy .from a remo
location for upgrading via the Core.
Example The following example copies Juniper ATP Appliance software to the Core
from a remote location defined by the path provided.
updateimage
Description Update or correct the guest-image OS profile used by the detection and
analysis 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.
Mode(s) Core
Syntax updateimage
Parameters
Updates the guest-image on the
built-in detection Engine.
Example The following example performs a built-in profile update for the Core
detection engine.
wizard
Description 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.
Mode(s) Basic
Syntax
wizard
57
Parameters None
hostname # wizard
Use DHCP to obtain the IP address and DNS server We strongly discourage the use of DHCP addressing
address for the administrative interface (Yes/No)? because it changes dynamically. A static IP address is
preferred.
Note: Only if your DHCP response is no ,enter the
following information when prompted: Recommended: Respond with no:
6. Do you want to enter the search domains? 6. Enter yes if you want DNS lookups to use a specific
domain.
7. Enter the search domain (separate multiple search
domains by space): 7. Enter search domain(s) separated by spaces; for
example: example.com lan.com dom2.com
Restart the administrative interface (Yes/No)?
Enter yes to restart with the new configuration settings
applied.
58
Enter a valid hostname. Type a hostname when prompted; do not include the
domain; for example: JuniperATP1.
Use alternate-exhaust for the analysis engine exhaust Enter the IP address for the eth2 interface.
traffic (Yes/No)?
Enter the eth2 netmask.
Enter IP address for the alternate-exhaust (eth2)
Enter the gateway IP address.
interface:
Regenerate the SSL self-signed certificate (Yes/No)? Enter yes to create a new SSL certificate for the Juniper
ATP Appliance Server Web UI.
SEE ALSO
IN THIS SECTION
CM Commands | 60
This chapter describes the commands for available for Juniper ATP Appliance Core/CM or vCore
servers. These commands are used to configure devices and software, manage security events, and show
system information and status.
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.
• "cm" on page 64
• "core" on page 64
• "diagnosis" on page 66
• "exit" on page 66
• "help" on page 68
• "history" on page 69
60
• "server" on page 77
Refer to the respective sections in this guide to review Diagnosis Mode, CM Mode, Collector Mode and
Server Mode commands per product device.
CM Commands
• "exit" on page 66
• "help" on page 68
• "history" on page 69
• "exit" on page 66
• "help" on page 68
• "history" on page 69
• "exit" on page 66
• "help" on page 68
• "history" on page 69
• "ifrestart" on page 70
61
• "ping" on page 71
• "reboot" on page 72
• "restart" on page 73
• "restore" on page 75
• "server" on page 77
• "shutdown" on page 99
• "traceroute" on page 54
• "capture-start" on page 63
• "copy" on page 65
• "exit" on page 66
• "gssreport" on page 67
• "help" on page 68
• "history" on page 69
• "setupcheck" on page 83
IN THIS SECTION
capture-start | 63
cm | 64
core | 64
copy | 65
diagnosis | 66
exit | 66
gssreport | 67
help | 68
history | 69
ifrestart | 70
ping | 71
reboot | 72
reset-admin-password | 72
restart | 73
restore | 75
server | 77
setupcheck | 83
shutdown | 99
traceroute | 100
upgrade | 101
63
updateimage | 101
wizard | 102
capture-start
Description Starts packet capture as a means for diagnosing and debugging network traffic and obtaining
stats.
See Also:[mode];
Mode(s) Diagnosis
Syntax capture-start
Sub-Commands None
Example The following example starts a packet capture process on interface eth1 for a Traffic Collector
with IP address 8.8.8.8:
hostname # diagnosis
NOTE: Note: Address 8.8.8.8 need not be a Juniper ATP Appliance. It is just a host that the
capture filters on.
64
cm
Table 40: cm
Mode(s) Basic
Syntax cm
Parameters None
hostname # cm
hostname (cm)#
core
Mode(s) Basic
65
Syntax core
Parameters None
hostname # core
hostname (core)#
copy
Description 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:[mode];
Mode(s) Diagnosis
Sub-Commands None
66
Example The following example copies the file "Eth1.txt" from the local host to a remote host:
mailto:[email protected]:/some/remote/directory
diagnosis
Mode(s) Basic
Syntax diagnosis
Parameters None
Sub-Commands ; ; ; ;;;;;;
Example The following example enters diagnosis configuration and status check mode:
hostname # diagnosis
hostname (diagnosis)# ?
exit
Syntax exit
Parameters None
gssreport
Description Use the gssreport command to submit reports to Juniper Global Security Services (GSS), and to
display the status of the current GSS report.
See Also:;[mode]
Mode(s) diagnosis
Sub-Commands None
68
Example The following examples display the status of a GSS report submission:
hostname # diagnosis
hostname (diagnosis)# gssreport submit
Successfully started GSS report
help
Syntax help
Parameters None
69
Example The following example shows some of the output of the help command.
history
Syntax history
Parameters None
Example The following examples returns command line history for the
current CLI session.
ifrestart
Description Restarts the interface driver and services using the interface.
Mode(s) Server
Parameters
eth0 Restarts the management network administra interface.
eth1 Restarts the monitoring network interface.
Example The following example restarts the eth0 interface for the management network.
ping
Description Sends ICMP (Internet Control Message Protocol) echo request packets to a specified host name
or IP address to verify that the destination is reachable over the network.
Mode(s) Server
Parameters
-ccount Number of echo requests to send. By default, pings ar continuously until you press
Ctrl+C.
Example The following example sends three echo requests to the device with the IP Address 10.10.10.1
reboot
Mode(s) Server
Syntax reboot
Parameters None
hostname# reboot
reset-admin-password
Description A sudo user named “recovery” uses this command to reset the admin
password. This user will not require any password and can only login on a
physical device, not using ssh login.
Mode(s) Server
Syntax recovery
NOTE: Since passwords do not sync across devices, you must perform this
reset manually on all ATP Appliance devices.
restart
Mode(s) Server
Parameters
all Restarts all Juniper ATP Appliance
services.
JATP# restart cm
75
restore
Description Restores the system configuration to the factory default settings. This will
only reset the password to default temporarily.
Mode(s) server
Parameters
support Restores the default support password setting
NOTE: vCore for AWS does not remote login (set during initial installation per l See
use the following CLI commands: also (server)# "set (server mode)" on page 78
restore hostname restore network
JATP# restore
This next example restores the SSH login “support” password to the
default
Description Resets the Secondary Core UUID, if the virtual core is cloned.
Syntax set id
Sub-Commands None
Example The following example sets the Virtual Core appliance id:
hostname # core
hostname (core) # set id
<cr>
77
server
Mode(s) Basic
Syntax server
Sub-Commands ;;;;;;;;;;
Whitelist rules rely on normal service shutdown to be backed up.Powering off a VM directly
will lose the allowlist state as rules cannot be saved in that case.
hostname # server
hostname (server) # ?
Description 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.
Syntax
set system-alert traffic <integer> time <interval>
NOTE: Note that both "traffic" and "time" parameters are required in order to set the threshold
for both the minimum traffic and time.
Parameters
traffic - the minimum traffic (in KB)
Example
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.
Syntax
set [autoupdate {on | off} | cli timeout secs | clock | cm
address | cysupport {enable | disable} localmode {enable |
disable}| passphrase string | dns | firewall {all <backup |
flush> | whitelist} | hostname string | ip interface {management
| alternate-exhaust}| ntpserver | password | proxy {config |
enabled | remove} | timezone string | uipassword]
Parameters
set ip
set hostname
Sets the IP address of the Central Manager and netmask using slash
cm address notation; ex: AAA.BBB.CCC.DD/X
password
Description Change the appliance type at any time. For example, change from All-In-
One to Core/CM. Note that if you change the appliance type after the
initial installation, all data files related to the current type are lost and
you must set up the appliance as you would a fresh box.
Mode(s) server
Syntax
jatp:AIO#(server)# set appliance-type core-cm
Parameters
all-in-one
core-cm
email-collector
traffic-collector
82
Example The following example changes the form factor of the appliance from all-
in-one (the default) to core-cm:
Description Sets the logging levels for Juniper ATP Appliance components from diagnosis
mode.
See Also:
Mode(s) diagnosis
Parameters
all Sets logging for all Juniper ATP Appliance components.
Example The following example sets the default logging level for all Juniper ATP
Appliance components.
setupcheck
Description Checks and reports on basic configuration settings and analysis pipeline setup.
Mode(s) diagnosis
Syntax
setupcheck {all | report | basic | analysis}
84
Parameters
all Checks both basic settings and analysis pipelin
report Shows report of last setupcheck.
basic Checks basic configuration settings.
analysis Checks the analysis pipeline.
Example The following example checks all basic configuration settings as well as the analysis pipeline:
Mode(s) Core
Syntax show
85
Parameters
images Displays guest image update and status information.
whitelist Displays the name, hit count and the time of last hit of a user
configured allowlist.
Note that when a allowlist 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.
Example The following example demonstrates the show images command usage:
The following example shows how to get the alternate-exhaust interface (eth2) status:
Description Sets the logging levels for Juniper ATP Appliance components from diagnosis mode.
See Also:
Mode(s) diagnosis
87
Syntax show
Parameters
device {collectorstatus | | Display connected device statistics for Traffic Collector,
corestatus | slavecorestatus} CoreCM, or Mac Mini Detection Engine Secondary “backup
core.”
protocol {web | email} Displays the session counts for network web or email
protocols.
log error traceback Displays 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: Displays n [1-1000] lines of the contents of the common log
number of lines to display> file.
Example The following example displays the connected Traffic Collector status.
IP : 10.2.9.68
Enabled : True
Last Seen : 2015-07-25 15:13:17.967000-07:00
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
Syntax
show
Parameters
See Also: Show the IP address of the management (administrative) interface eth0.
show controller
ip Results may show both private and public IP addresses if the AWS vCore has
a public IP.
See also show (collector mode) cpuload shows average CPU load in the system for running processes in the
for show proxy inside/outside last 1, 5 and 15 min intervals.
data path
91
Cancun America/Caracas
America/Catamarca America/Cayenne America/
Cayman America/Chicago America/
Chihuahua America/Coral_Harbour
America/Cordoba America/Costa_Rica America/
Creston America/Cuiaba America/
Curacao America/Danmarkshavn
America/Dawson America/Dawson_Creek America/
Denver America/Detroit America/
Dominica America/Edmonton
America/Eirunepe America/El_Salvador America/
Ensenada America/Fort_Nelson America/
Fort_Wayne America/Fortaleza
America/Glace_Bay America/Godthab America/
Goose_Bay America/Grand_Turk America/
Grenada America/Guadeloupe
America/Guatemala America/Guayaquil America/
Guyana America/Halifax America/
Havana America/Hermosillo
America/Indiana/Indianapolis America/Indiana/Knox America/
Indiana/Marengo America/Indiana/Petersburg America/Indiana/
Tell_City America/Indiana/Vevay
America/Indiana/Vincennes America/Indiana/Winamac America/
Indianapolis America/Inuvik America/
Iqaluit America/Jamaica
America/Jujuy America/Juneau America/
Kentucky/Louisville America/Kentucky/Monticello America/
Knox_IN America/Kralendijk
America/La_Paz America/Lima America/
Los_Angeles America/Louisville America/
Lower_Princes America/Maceio
America/Managua America/Manaus America/
Marigot America/Martinique America/
Matamoros America/Mazatlan
America/Mendoza America/Menominee America/
Merida America/Metlakatla America/
Mexico_City America/Miquelon
America/Moncton America/Monterrey America/
Montevideo America/Montreal America/
Montserrat America/Nassau
America/New_York America/Nipigon America/
Nome America/Noronha America/
North_Dakota/Beulah America/North_Dakota/Center
America/North_Dakota/New_Salem America/Nuuk America/
Ojinaga America/Panama America/
Pangnirtung America/Paramaribo
94
Australia/Tasmania Australia/Victoria
Australia/West Australia/Yancowinna Brazil/
Acre Brazil/DeNoronha Brazil/
East Brazil/West
Canada/Atlantic Canada/Central Canada/
Eastern Canada/Mountain Canada/
Newfoundland Canada/Pacific
Canada/Saskatchewan Canada/Yukon Chile/
Continental Chile/EasterIsland Etc/
GMT Etc/GMT+0
Etc/GMT+1 Etc/GMT+10 Etc/GMT
+11 Etc/GMT+12 Etc/GMT
+2 Etc/GMT+3
Etc/GMT+4 Etc/GMT+5 Etc/GMT
+6 Etc/GMT+7 Etc/GMT
+8 Etc/GMT+9
Etc/GMT-0 Etc/GMT-1 Etc/
GMT-10 Etc/GMT-11 Etc/
GMT-12 Etc/GMT-13
Etc/GMT-14 Etc/GMT-2 Etc/
GMT-3 Etc/GMT-4 Etc/
GMT-5 Etc/GMT-6
Etc/GMT-7 Etc/GMT-8 Etc/
GMT-9 Etc/GMT0 Etc/
Greenwich Etc/UCT
Etc/UTC Etc/Universal Etc/
Zulu Europe/Amsterdam Europe/
Andorra Europe/Astrakhan
Europe/Athens Europe/Belfast Europe/
Belgrade Europe/Berlin Europe/
Bratislava Europe/Brussels
Europe/Bucharest Europe/Budapest Europe/
Busingen Europe/Chisinau Europe/
Copenhagen Europe/Dublin
Europe/Gibraltar Europe/Guernsey Europe/
Helsinki Europe/Isle_of_Man Europe/
Istanbul Europe/Jersey
Europe/Kaliningrad Europe/Kiev Europe/
Kirov Europe/Lisbon Europe/
Ljubljana Europe/London
Europe/Luxembourg Europe/Madrid Europe/
Malta Europe/Mariehamn Europe/
Minsk Europe/Monaco
Europe/Moscow Europe/Nicosia Europe/
Oslo Europe/Paris Europe/
Podgorica Europe/Prague
97
TIP:
Example The following example displays information about the CoreCM server device
type:
Full
Auto-negotiation: Yes Medium: Copper
RX packets: 1869032424 Bytes: 1716560257902 Errors: 0
Overruns: 0
TX packets: 409287 Bytes: 44607401 Errors: 0 Overruns: 0
Traffic rate for the last 5 seconds/1 minute/5 minutes
RX bits/sec: 108616/160176/442736
RX packets/sec: 44/46/91
TX bits/sec: 0/112/128
TX packets/sec: 0/0/0
shutdown
Mode(s) Server
Syntax shutdown
Parameters None
JATP# shutdown
traceroute
Mode(s) Server
Syntax traceroute
Parameters
-h unsigned integer Specifies the number of hops
upgrade
Description Upgrade Juniper ATP Appliance software for the Core/CM device or vCore, and all connected
physical or virtual devices.
Mode(s) cm
Syntax
upgrade <URI as user@hostname:path>
Parameters
<String_URI> Specifies the software packages to copy .from a remo location for upgrading
via the Core.
Example The following example copies Juniper ATP Appliance software to the Core from a remote
location defined by the path provided.
updateimage
Description Update or correct the guest-image OS profile used by the detection and analysis behavioral
engine.
The updateimage command will update the guest images from a USB drive attached to the
Juniper ATP Appliance.
Mode(s) Core
102
Syntax updateimage
Parameters
built-in Updates the guest-image on the detection Engine.
Example The following example performs a built-in profile update for the Core detection engine.
wizard
Description Enters the Configuration Wizard. For Configuration Wizard commands and response, see
“Configuration Wizard for the CoreCM Server” in the next section to follow command prompts
and recommended responses.
Mode(s) Basic
Parameters wizard
Example None
103
hostname # wizard
NOTE: Enter CTRL-C to exit the Configuration Wizard at any time. If you exit without completing
the configuration, you will be prompted again whether to run the Configuration Wizard.
You may also rerun the Configuration Wizard at any time with the CLI command wizard.
Use DHCP to obtain the IP address and DNS We strongly discourage the use of DHCP addressing
server address for the administrative interface because it changes dynamically. A static IP address is
(Yes/No)? preferred.
NOTE: Only if your DHCP response is no,enter the Recommended: Respond with no:
following information when prompted:
1. Enter an IP address
1. IP address (no CIDR format)
2. Enter a netmask using the form 255.255.255.0.
2. Netmask
3. Enter a gateway IP address.
3. Enter a gateway IP address for this
management (administrative) interface: 4. Enter the DNS server IP address
4. Enter primary DNS server IP address. 5. If yes, enter the IP address of the secondary DNS
server.
5. Do you have a secondary DNS Server (Yes/No).
6. Enter yes if you want DNS lookups to use a specific
6. Do you want to enter the search domains? domain.
7. Enter the search domain (separate multiple 7. Enter search domain(s) separated by spaces; for
search domains by space): example: example.com lan.com dom2.com
Restart the administrative interface (Yes/No) Enter yes to restart with the new configuration settings
applied.
104
Enter a valid hostname. Type a hostname when prompted; do not include the
domain; for example: juniperatp1
Use alternate-exhaust for the analysis engine Enter the IP address for the eth2 interface.
exhaust traffic (Yes/No)?
Enter the eth2 netmask.
Enter IP address for the alternate-exhaust (eth2)
Enter the gateway IP address.
interface:
Regenerate the SSL self-signed certificate (Yes/ Enter yes to create a new SSL certificate for the Juniper
No)? ATP Appliance Server Web UI.
Central Manager (CM) IP Address: Enter Yes; the system will auto-set IP 127.0.0.1 as the All-
in-One IP address.
Device Name: (must be unique)
Enter a connected Juniper ATP Appliance Collector Device
Device Name: (must be unique) Name; this identifies the Collector in the Web UI.
NOTE: Remember this passphrase and use it for all Enter a user-defined PassPhrase to be used to authenticate
distributed devices. the Core to the Central Manager.
SEE ALSO
IN THIS SECTION
This chapter describes the CLI commands available for the Mac Mini Mac OS X “Secondary Core”
detection engine device. There is no Collector Mode on this device.
106
NOTE: You must enclose non-alphabet characters in double quotes in CLI 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.
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.
• "traceroute" on page 54
IN THIS SECTION
capture-start | 109
copy | 109
core | 110
diagnosis | 111
exit | 112
gssreport | 112
help | 113
histroy | 114
ifrestart | 115
ping | 116
reboot | 117
restart | 117
restore | 118
server | 119
setupcheck | 123
shutdown | 130
traceroute | 131
updateimage | 132
upgrade | 133
wizard | 133
109
capture-start
Description Starts packet capture as a means for diagnosing and debugging network traffic and obtaining
stats.
Mode(s) Diagnosis
Syntax capture-start
Sub-Commands None
Example The following example starts a packet capture process on interface eth1 for a Traffic Collector
with IP address 8.8.8.8:
hostname # diagnosis
NOTE: Note: Address 8.8.8.8 need not be a Juniper ATP Appliance. It is just a host that the
capture filters on.
copy
Description 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.
Mode(s) Diagnosis
Syntax
copy capture <scp source_file_name
username@destination_host:destination_folder> | traceback all
<string URI as user@hostname:path>
Parameters
copy capture <scp remote filename_location>
copy traceback all <path string>
copy traceback <tab> [tab displays all available crash filenames]
Sub-Commands None
Example The following example copies the file "captureEth1.txt" from the
local host to a remote host:
mailto:[email protected]:/some/remote/directory
core
Mode(s) Basic
Syntax core
111
Parameters None
hostname # core
hostname (core)#
diagnosis
Mode(s) Basic
Syntax diagnosis
Parameters None
Sub-Commands ;;; ; ; ; ;; ;
Example The following example enters diagnosis configuration and status check mode:
hostname # diagnosis
hostname (diagnosis)# ?
112
exit
Syntax exit
Parameters None
gssreport
Description Use the gssreport command to submit reports to Juniper Global Security Services (GSS), and to
display the status of the current GSS report.
See Also:;[mode]
Mode(s) diagnosis
Sub-Commands None
Example The following examples display the status of a GSS report submission:
hostname # diagnosis
hostname (diagnosis)# gssreport submit
Successfully started GSS report
help
Syntax help
Parameters None
114
Example The following example shows some of the output of the help command.
histroy
Syntax history
Parameters None
Example The following examples returns command line history for the
current CLI session.
ifrestart
Description Restarts the interface driver and services using the interface.
Mode(s) Server
Parameters
eth0 Restarts the management network administra
interface.
eth1 Restarts the monitoring network interface.
Example The following example restarts the eth0 interface for the
management network.
ping
Description Sends ICMP (Internet Control Message Protocol) echo request packets to a specified host name
or IP address to verify that the destination is reachable over the network.
Mode(s) Server
Parameters
-ccount Number of echo requests to send. By default, pings ar continuously until you press
Ctrl+C.
Example The following example sends three echo requests to the device with the IP Address 10.10.10.1
reboot
Mode(s) Server
Syntax reboot
Parameters None
hostname# reboot
restart
Mode(s) Server
Parameters
all Restarts all Juniper ATP Appliance
services.
JATP# restart cm
restore
Description Restores the system configuration to the factory default settings. This will
only reset the password to default temporarily.
Mode(s) server
Parameters
support Restores the default support password setting
NOTE: vCore for AWS does not remote login (set during initial installation per l See
use the following CLI commands: also (server)# "set (server mode)" on page 120
restore hostname restore network
JATP# restore
This next example restores the SSH login “support” password to the
default
server
Mode(s) Basic
Syntax server
Sub-Commands ;;;;;;;;;;
Whitelist rules rely on normal service shutdown to be backed up.Powering off a VM directly
will lose the allowlist state as rules cannot be saved in that case.
hostname # server
hostname (server) # ?
Syntax
set [autoupdate {on | off} | cli timeout secs | clock | cm address
| cysupport {enable | disable} localmode {enable | disable}|
passphrase string | dns | firewall {all <backup | flush> |
whitelist} | hostname string | ip interface {management |
alternate-exhaust}| ntpserver | password | proxy {config | enabled
| remove} | timezone string | uipassword]
Parameters
Sets the IP address of the Central Manager and netmask using slash
cm address notation; ex: AAA.BBB.CCC.DD/X
passphrase string Sets DNS (or enables DHCP for DNS) for the management interface
by default if interface is unspecified.
dns
Backs up or flushes (clears) all current iptables for a firewall, or adds,
deletes or flushes the current iptables allowlist-specific settings for
firewall {all <backup | flush> |
the firewall.
whitelist <add | delete | flush>}
The “add” option adds an IP address to the iptables outbound
NOTE: Whitelist rules rely on normal allowlist.
service shutdown for backup.Powering
off a VM directly loses the allowlist state # set firewall whitelist add 10.1.1.1
as rules cannot be saved in that case.
Sets the system’s host name.
hostname string Sets the IP address, netmask, or default gateway, or enables DHCP
for the management or alternate-exhaust interface.
ip interface {management |
alternateexhaust} <dhcp | address |
netmask | gateway}
Examples The following example sets an ip address for the device management
interface eth0.
Description Sets the logging levels for Juniper ATP Appliance components from diagnosis
mode.
See Also:
Mode(s) diagnosis
Parameters
all Sets logging for all Juniper ATP Appliance components.
Example The following example sets the default logging level for all Juniper ATP
Appliance components.
setupcheck
Description Checks and reports on basic configuration settings and analysis pipeline
setup.
Mode(s) diagnosis
Syntax
setupcheck {all | report | basic | analysis}
124
Parameters
all Checks both basic settings and analysis
pipelin.
Example The following example checks all basic configuration settings as well as the
analysis pipeline:
Mode(s) Core
Syntax show
125
Parameters
images Displays guest image update
and status information.
Description Sets the logging levels for Juniper ATP Appliance components from
diagnosis mode.
See Also:
126
Mode(s) diagnosis
Syntax show
127
Parameters
device {collectorstatus | | Display connected device statistics for
corestatus | Traffic Collector, CoreCM, or Mac Mini
slavecorestatus} Detection Engine Secondary “backup
core.”
Example The following example displays the connected Traffic Collector status.
Syntax
show
Parameters
interface [management | (administrative) network interface eth0, or the monitoring interface (eth1),
monitoring | alternateexhaust] or the alternate-exhaust interface (eth2).
• cpuload shows the average CPU load in the system for running
processes in the last 1, 5 and 15 minute intervals.
version Show Juniper ATP Appliance software and content security versions.
Example The following example displays information about the MacOSX cpuload
statistics:
shutdown
Mode(s) Server
Syntax shutdown
Parameters None
131
JATP# shutdown
traceroute
Mode(s) Server
Syntax traceroute
Parameters
-h unsigned integer Specifies the number of hops
updateimage
Mode(s) Core
Syntax updateimage
Parameters
built-in Updates the guest-image on the Mac OSX Detection
“Secondary core.”.
Example The following example performs a built-in profile update for the
Core detection engine.
upgrade
Description 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 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.
Mode(s) Core
Syntax upgrade
Parameters
built-in Updates the guest-image on the Mac OSX Detection “secondary core.”.
Example 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
Description Enters the Configuration Wizard. For Configuration Wizard commands and response, see
“Configuration Wizard for the CoreCM Server” in the next section to follow command prompts
and recommended responses.
134
Mode(s) Basic
Parameters wizard
Example None
hostname # wizard
Use DHCP to obtain the IP address and DNS We strongly discourage the use of DHCP addressing
server address for the administrative interface because it changes dynamically. A static IP address is
(Yes/No)? preferred.
NOTE: Only if your DHCP response is no,enter the Recommended: Respond with no:
following information when prompted:
1. Enter an IP address
1. IP address (no CIDR format)
2. Enter a netmask using the form 255.255.255.0.
2. Netmask
3. Enter a gateway IP address.
3. Enter a gateway IP address for this
management (administrative) interface: 4. Enter the DNS server IP address
4. Enter primary DNS server IP address. 5. If yes, enter the IP address of the secondary DNS server.
5. Do you have a secondary DNS Server (Yes/ 6. Enter yes if you want DNS lookups to use a specific
No). domain.
6. Do you want to enter the search domains? 7. Enter search domain(s) separated by spaces; for
example: example.com lan.com dom2.com
7. Enter the search domain (separate multiple
search domains by space): Enter yes to restart with the new configuration settings
applied.
Restart the administrative interface (Yes/No)?
Enter a valid hostname. Type a hostname when prompted; do not include the
domain; for example: juniperatp1
Use alternate-exhaust for the analysis engine Enter the IP address for the eth2 interface.
exhaust traffic (Yes/No)?
Enter the eth2 netmask.
Enter IP address for the alternate-exhaust (eth2)
Enter the gateway IP address.
interface:
Regenerate the SSL self-signed certificate (Yes/ Enter yes to create a new SSL certificate for the Juniper
No)? ATP Appliance Server Web UI.
Enter the following server attributes: Required:Enter the IP address of the Juniper ATP Appliance
Server Core/CM or All-in-One.
Central Manager (CM) IP Address:
Enter a Juniper ATP Appliance Mac Mini or Core/CM
Device Name: (must be unique) Device Name; this identifies the Mac OS X or Core Engine
in the Web UI.
Device Description
SEE ALSO
IN THIS SECTION
traceroute | 171
This chapter describes the commands specific to the Juniper ATP Appliance Collector CLI. The available
commands are as follows:
IN THIS SECTION
capture-start | 140
collector | 141
copy | 142
diagnosis | 143
exit | 143
gssreport | 144
help | 145
history | 146
ifrestart | 147
ping | 148
reboot | 149
140
restart | 149
restore | 150
server | 151
set traffic-monitoring (for JATP700 and JATP400 Appliances) (collector mode) | 162
setupcheck | 162
shutdown | 170
capture-start
Mode(s) Diagnosis
Syntax capture-start
Sub-Commands None
hostname # diagnosis
collector
Mode(s) Basic
Syntax collector
Parameters None
Sub-Commands "exit" on page 143;"help" on page 145; "history" on page 146; "set
proxy (collector mode)" on page 153; "show (collector mode)" on page
163
hostname # collector
hostname (collector)# ?
142
copy
Description 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.
Mode(s) Diagnosis
Syntax
copy capture <scp source_file_name
username@destination_host:destination_folder> | traceback all
<string URI as user@hostname:path>
Parameters
copy capture <scp remote filename_location>
copy traceback all <path string>
copy traceback <tab> [tab displays all available crash filenames]
Sub-Commands None
Example The following example copies the file "captureEth1.txt" from the local
host to a remote host:
mailto:[email protected]:/some/remote/directory
143
diagnosis
Mode(s) Basic
Syntax diagnosis
Parameters None
Sub-Commands "capture-start" on page 140; "copy" on page 142; "exit" on page 143;
"gssreport" on page 144; "help" on page 145; "history" on page 146;
"set (server mode)" on page 157; "setupcheck" on page 162; "show
(diagnosis mode)" on page 165; "show (server mode)" on page 167
Example The following example enters diagnosis configuration and status check
mode:
hostname # diagnosis
hostname (diagnosis)# ?
exit
Syntax exit
Parameters None
gssreport
Mode(s) diagnosis
Sub-Commands None
145
Example The following examples display the status of a GSS report submission:
hostname # diagnosis
hostname (diagnosis)# gssreport submit
Successfully started GSS report
help
Syntax help
Parameters None
146
Example The following example shows some of the output of the help command.
history
Syntax history
Parameters None
Example The following examples returns command line history for the current
CLI session.
JATP# history
ifrestart
Description Restarts the interface driver and services using the interface.
Mode(s) Server
Parameters
eth0 Restarts the management network administra interface.
eth1 Restarts the monitoring network interface.
Example The following example restarts the eth0 interface for the management
network.
ping
Description Sends ICMP (Internet Control Message Protocol) echo request packets
to a specified host name or IP address to verify that the destination is
reachable over the network.
Mode(s) Server
Parameters
-ccount Number of echo requests to send. By default, pings ar
continuously until you press Ctrl+C.
Example The following example sends three echo requests to the device with
the IP Address 10.10.10.1
reboot
Mode(s) Server
Syntax reboot
Parameters None
hostname# reboot
restart
Mode(s) Server
Parameters
all Restarts all Juniper ATP Appliance
services.
JATP# restart cm
restore
Description Restores the system configuration to the factory default settings. This will
only reset the password to default temporarily.
Mode(s) server
Parameters
support Restores the default support password setting
NOTE: vCore for AWS does not remote login (set during initial installation per l See
use the following CLI commands: also (server)# "set (server mode)" on page 157
restore hostname restore network
JATP# restore
This next example restores the SSH login “support” password to the
default
server
See Also:
152
Mode(s) Basic
Syntax server
Sub-Commands "exit" on page 143; "help" on page 145; "history" on page 146;
"ifrestart" on page 147; "ping" on page 148; "reboot" on page
149;"restore" on page 150; "set (server mode)" on page 157; "show
(server mode)" on page 167
hostname # server
hostname (server) # ?
153
Description Sets an Inside or Outside data path proxy from collector mode.
See Also: ;
Mode(s) collector
Syntax
set proxy inside {add <proxy IP address> <proxy port> | remove
<proxy IP address> <proxy port>
Parameters
inside Sets the inside proxy IP addresses
Description Enables and disables the SSH-Honeypot feature for a Traffic Collector.
• Enable/disable a honeypot
Mode(s) collector
Syntax
(collector)# set honeypot ssh-honeypot enable dhcp
Example The following example enables the SMB parser for lateral detections:
Description Sets the logging levels for Juniper ATP Appliance components from
diagnosis mode.
See Also: ;
Mode(s) diagnosis
Parameters
all Sets logging for all Juniper ATP Appliance components.
Example The following example sets the default logging level for all Juniper ATP
Appliance components.
Description Enables and disables the HTTP or SMB parser for a Traffic Collector.
Mode(s) collector
Example The following example enables the SMB parser for lateral detections:
Mode(s) Server, See Also:; "set proxy (collector mode)" on page 153
Syntax
set [autoupdate {on | off} | cli timeout secs | clock | cm address |
cysupport {on | off} | passphrase string | dns | firewall {all
<backup | flush> | whitelist} | hostname string | ip {interface |
dhcp | address | netmask | gateway} | ntpserver | password | proxy
{config | enabled | remove} |timezone string | uipassword]
Parameters
Sets the IP address of the Central Manager and netmask using the slash
cm address notation; example: AAA.BBB.CCC.DD/x
Sets the DNS servers (or enable DHCP for DNS) for the management
dns interface eth0.
Examples The following example sets an ip address for the device management
interface eth0.
Description Change the appliance type at any time. For example, change from All-In-
One to Core/CM. Note that if you change the appliance type after the
initial installation, all data files related to the current type are lost and
you must set up the appliance as you would a fresh box.
Mode(s) server
Syntax
jatp:AIO#(server)# set appliance-type core-cm
160
Parameters
all-in-one
core-cm
email-collector
traffic-collector
Example The following example changes the form factor of the appliance from all-
in-one (the default) to core-cm:
Description 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 cannot be reversed. This command can be
applied to an entire network/subnet/ CIDR range.
Mode(s) collector
Syntac
set traffic-filter {add <rule_name> <domain> <sourceaddress>
<destination-address> <source-port> <destination-port> <protocol> |
remove <rule_name>}
161
Parameters
Adds a traffic filter rule where:
traffic-filter add
Example The following example add a traffic filter rule to the Traffic Collector.
Description Sets the traffic monitoring interface on the JATP700 and JATP400.
Mode(s) collector
Syntax
# set traffic-monitoring-ifc 1gb_ifc
setupcheck
Description Checks and reports on basic configuration settings and analysis pipeline
setup.
Mode(s) diagnosis
Syntax
setupcheck {all | report | basic | analysis}
163
Parameters
all Checks both basic settings and analysis
pipelin.
Example The following example checks all basic configuration settings as well as
the analysis pipeline:
Description Displays the Traffic Collector current traffic filters and the current XFF
status (enabled or disabled)
Mode(s) Collector
Subcommands
traffic-filter | proxy | honeypot
Syntax show
164
Parameters
Shows all traffic filter rules.
traffic-filter
Example The following example displays the current Collector proxy inside
settings:
The following example displays the current SMB protocol parser setting:
Description Sets the logging levels for Juniper ATP Appliance components from
diagnosis mode.
See Also:;
Mode(s) diagnosis
Syntax show
166
Parameters
device {collectorstatus | | Display connected device statistics for
corestatus | Traffic Collector, CoreCM, or Mac Mini
slavecorestatus} Detection Engine Secondary “backup
core.”
Example The following example displays the connected Traffic Collector status.
IP : 10.2.9.68
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
Last Seen : 2014-07-28 11:07:42.046000-07:00
Install Date : 2013-11-14 09:25:39-08:00
Syntax
show
Parameters
Example The following example displays information about the All-in-One server
device type:
shutdown
Mode(s) Server
Syntax shutdown
Parameters None
JATP# shutdown
171
traceroute
IN THIS SECTION
wizard | 172
Syntax traceroute
Parameters
-h unsigned integer Specifies the number of hops
wizard
Mode(s) Basic
Syntax wizard
Parameters None
hostname # wizard
Use DHCP to obtain the IP address We strongly discourage the use of DHCP addressing because it changes
and DNS server address for the dynamically. A static IP address is preferred.
administrative interface (Yes/No)?
Recommended: Respond with no:
NOTE: Only if your DHCP response
is no ,enter the following information 1. Enter an IP address
when prompted:
2. Enter a netmask using the form 255.255.255.0.
1. IP address (no CIDR format)
3. Enter a gateway IP address.
2. Netmask
4. Enter the DNS server IP address
3. Enter a gateway IP address for
5. If yes, enter the IP address of the secondary DNS server.
this management (administrative)
interface: 6. Enter yes if you want DNS lookups to use a specific domain.
4. Enter primary DNS server IP 7. Enter search domain(s) separated by spaces; for example:
address. example.com lan.com dom2.com
5. Do you have a secondary DNS Enter yes to restart with the new configuration settings applied.
Server (Yes/ No).
Enter a valid hostname. Type a hostname when prompted; do not include the domain; for
example: juniperatp1
NOTE: Only alphanumeric characters and hyphens (in the middle of the
hostname) are allowed.
Enter the following server attributes: Required: Enter the IP address of the Juniper ATP Appliance Server All-
in-One CM or CoreCM to which you are connecting [another] Collector
Central Manager (CM) IP Address: in order to register with and view the Collector in the CM Web UI.
Device Name: (must be unique) Enter the Juniper ATP Appliance Collector Device
Device Description Name; this identifies the Collector in the Web UI.
NOTE: Remember this passphrase Enter the same PassPhrase used to authenticate the Collector to the
and use it for all distributed devices! Central Manager.
NOTE: Enter CTRL-C to exit the Configuration Wizard at any time. If you exit without completing
the
SEE ALSO
Glossary of Terms
Alternate Exhaust Interface An eth2 interface configured (optionally) to contain analysis engine CnC traffic
off the management network (eth0).
Anti-SIEM A Juniper ATP Appliance Advanced Threat Analytics (ATA) feature that allows
for more detailed endpoint and log ingestion handling, management and
reporting; includes Active Directory, Splunk and Direct Log Ingestion options.
AWS Amazon Web Services and EC2 management console from which Juniper ATP
Appliance administrators can configure vCore AMI images.
175
Collector Juniper ATP Appliance’s Traffic inspection and object collection mechanism
CnC server Command and control server that directs the operation of a botnet.
CLI Command-line interface. The Juniper ATP Appliance has a CLI interface for
administering the appliance.
CM The Juniper ATP Appliance Central Manager component that has a web-based
graphical user interface.
DMZ Demilitarized zone. An area of the network where systems have direct access
to the Internet or an external network.
Greylist Greylists provide control over the priority of workorders for known IP
addresses and URLs. Greylists contain files that contain either URLs or IP
addresses and are used by the Juniper ATP Appliance analysis engines to check
if the specified URLs or IP addresses contain a malicious rule match.
GUI Graphical user interface. The Juniper ATP Appliance uses a web-based GUI for
managing the appliance.
Known botnet server bot Events that are triggered when the appliance sees any of the common IRC bot
command commands or detects any communication sent to known botnet servers.
176
Lateral Detection East-west detection of malware within the enterprise spread from endpoint
host to host.
Malware Malicious software used by attackers to disrupt, control, steal, cause data loss,
spy upon, or gain unauthorized access to computer systems.
OSPF Open Shortest Path First. A protocol that computes an optimal path for traffic
in a TCP/IP network.
Sandbox mode A mode in which malware is permitted to run, but results of the malware action
are restricted to the virtual machine and not permitted to escape.
Zero-day attack An attack by malware that exploits unknown or newly discovered vulnerabilities
in software before they become known or before security patches are applied
to fix them
RELATED DOCUMENTATION