Pan Os 6.1 Cli Ref
Pan Os 6.1 Cli Ref
Pan Os 6.1 Cli Ref
Contact Information
Corporate Headquarters:
For information on the additional capabilities and for instructions on configuring the features on the firewall, refer
to https://www.paloaltonetworks.com/documentation.
For access to the knowledge base, complete documentation set, discussion forums, and videos, refer to
https://live.paloaltonetworks.com.
For contacting support, for information on the support programs, or to manage your account or devices, refer to
https://support.paloaltonetworks.com
II
Table of Contents
Chapter 1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Understanding the PAN-OS CLI Structure . . . . . . . . . . . . . . . . . . . . . . . . 13
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Accessing the PAN-OS CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Understanding the PAN-OS CLI Commands . . . . . . . . . . . . . . . . . . . . . . . 15
Understanding the PAN-OS CLI Command Conventions . . . . . . . . . . . . . . . . . . 15
Understanding Command Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Using Operational and Configuration Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Displaying the PAN-OS CLI Command Options . . . . . . . . . . . . . . . . . . . . . . . . . 17
Using Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Understanding Command Option Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Restricting Command Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Understanding Privilege Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Referring to Device Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Chapter 2
Understanding CLI Command Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Understanding Configuration Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Using Configuration Mode Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Configuration Commands with Virtual Systems . . . . . . . . . . . . . . . . . . . .
Understanding the Configuration Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Navigating Through the Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23
25
26
28
Understanding Operational Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Setting the Output Format for Configuration Commands . . . . . . . . . . . . . . . . . . 30
Chapter 3
Configuration Mode Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
37
38
39
40
41
42
43
III
load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
rename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
set address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
set address-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
set application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
set application-filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
set application-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
set captive-portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
set device-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
set deviceconfig high-availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
set deviceconfig setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
set deviceconfig system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
set display-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
set email-scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
set external-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
set global-protect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
set group-mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
set log-collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
set log-collector-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
set mgt-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
set network dhcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
set network dns-proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
set network ike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
set network interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
set network profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
set network qos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
set network shared-gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
set network tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
set network virtual-router . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
set network virtual-router multicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
set network virtual-router protocol bgp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
set network virtual-router protocol ospf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
set network virtual-router protocol ospfv3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
set network virtual-router protocol redist-profile . . . . . . . . . . . . . . . . . . . . . . . 186
set network virtual-router protocol redist-profile-ipv6 . . . . . . . . . . . . . . . . . . . 188
set network virtual-router protocol rip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
set network virtual-wire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
set network vlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
set ocsp-responder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
set panorama . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
set pdf-summary-report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
set profile-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
set profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
set region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
set report-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
set reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
set rulebase or set vsys rulebase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
set schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
set service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
IV
set service-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared admin-role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared alg-override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared authentication-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared authentication-sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared botnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared certificate-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared email-scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared local-user-database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared log-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared pdf-summary-report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared post-rulebase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared pre-rulebase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared report-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared response-page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared server-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set shared ssl-decrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set threats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set ts-agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set url-admin-override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set url-content-types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set user-id-agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set user-id-agent-sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set user-id-collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set vsys application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set vsys import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show deviceconfig setting ssl-decrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
233
234
235
248
249
251
252
254
255
256
257
258
263
264
265
266
267
268
273
274
276
277
278
282
283
284
285
286
287
290
291
293
294
295
296
297
Chapter 4
Operational Mode Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
299
clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
commit-all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug authd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug cli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug cryptod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug dataplane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug device-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug dhcpd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug dnsproxyd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug global-protect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug high-availability-agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug ike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
305
311
312
313
314
315
316
329
335
336
337
338
339
debug keymgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug l3svc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug log-card-interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug log-collector-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug log-receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug logview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug management-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug master-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug mprelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug netconfig-agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug pppoed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug rasmgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug satd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug ssl-vpn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug sslmgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug swm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug tac-login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug user-id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug vardata-receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug wildfire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
diff-all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
grep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
less . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
netstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request acknowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request analyze-shared-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request anti-virus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request batch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request chassis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request commit-lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request config-backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request config-lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request data-filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request device-registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request dhcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request global-protect-client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request global-protect-gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request global-protect-portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request global-protect-satellite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request high-availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request hsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request last-acknowledge-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VI
340
341
342
343
344
345
346
350
351
352
353
354
355
357
358
360
361
363
364
365
366
372
373
375
378
379
380
381
382
383
384
385
387
389
390
391
392
394
400
402
403
404
405
406
408
409
410
411
412
413
414
415
416
417
request license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request log-fwd-ctrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request master-key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request password-change-history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request password-hash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request push-report-definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request quota-enforcement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request tech-support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request url-filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request wildfire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
scp export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
scp import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set cli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set data-access-password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set management-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set panorama . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set serial-number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set ssh-authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show admins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show arp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show chassis-ready . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show chassis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show cli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show collector-messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show commit-locks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show config-locks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show counter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show deployment-update-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show device-messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show devicegroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show dhcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show dlc-query-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show dlc-query-ui . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show dns-proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show dos-protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show fips-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show global-protect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show global-protect-gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show global-protect-mdm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
418
419
420
421
422
423
424
425
426
427
428
429
431
432
434
435
437
440
442
444
446
447
448
449
450
451
452
454
455
458
459
460
461
462
463
464
465
466
467
468
469
472
473
474
475
476
477
478
479
480
481
482
483
485
VII
show global-protect-satellite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show high-availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show hsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show lacp aggregate-ethernet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show log-collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show log-collector-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show logging-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show mac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show management-clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show migration-log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show neighbor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show operational-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show panorama-certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show panorama-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show pbf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show pppoe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show qos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show rule-use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show running . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show sslmgr-store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show threat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show url-cloud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show virtual-wire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show vlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show vm-monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show vpn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show wildfire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show zone-protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
tail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
tcpdump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
tftp export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
tftp import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
traceroute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
view-pcap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VIII
486
487
488
489
491
492
494
495
510
511
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
529
530
537
538
542
546
548
549
553
554
555
556
560
561
562
563
565
568
569
570
571
572
573
578
580
582
584
Chapter 5
GP-100 GlobalProtect Mobile Security Manager Commands . . . . . . . .
587
589
590
591
592
593
594
595
596
598
599
600
601
602
603
604
607
615
616
618
619
622
623
641
642
647
649
650
651
652
653
654
655
658
659
660
662
664
665
666
667
671
672
673
674
675
676
679
680
IX
debug software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug swm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug tac-login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
debug user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
grep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
less . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
netstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request commit-lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request config-lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request device-registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request generate-report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request global-protect-gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request master-key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request password-change-history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request password-hash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request quota-enforcement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
request tech-support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
scp export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
scp import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set cli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set data-access-password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set management-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set ssh-authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
set system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show admins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show arp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show cli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show commit-locks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show config-locks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show counter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show fips-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show host-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
682
683
684
685
686
687
689
690
691
692
693
694
696
698
699
701
702
703
705
706
707
708
709
710
711
712
713
714
715
716
717
719
720
721
723
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
741
742
743
745
show log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show malware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show management-clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show mobile-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show operational-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
show user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
tail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
traceroute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
746
749
750
751
752
753
754
755
757
759
760
762
763
Chapter 6
Maintenance Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
765
Appendix A
PAN-OS CLI Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
771
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
775
XI
XII
Chapter 1
Introduction
This chapter introduces and describes how to use the PAN-OS command line interface (CLI):
Operational modeView the state of the system, navigate the PAN-OS CLI, and enter
configuration mode.
Introduction 13
Getting Started
This section describes how to access and begin using the PAN-OS CLI:
Data bits: 8
Parity: none
Stop bits: 1
2.
3.
4.
The PAN-OS CLI opens in Operational mode, and the CLI prompt is displayed:
username@hostname>
14 Introduction
Example:
username@hostname>
When you enter Configuration mode, the prompt changes from > to #:
username@hostname>
(Operational mode)
username@hostname> configure
Entering configuration mode
[edit]
(Configuration mode)
username@hostname#
In Configuration mode, the current hierarchy context is shown by the [edit...] banner presented in
square brackets when a command is issued. Refer to Using the Edit Command on page 29 for
additional information on the edit command.
Introduction 15
Each time you enter a command the syntax is checked. If the syntax is correct, the command is
executed, and the candidate hierarchy changes are recorded. If the syntax is incorrect, an invalid syntax
message is presented, as in the following example:
username@hostname# set zone application 1.1.2.2
Unrecognized command
Invalid syntax.
[edit]
username@hostname#
16 Introduction
To enter Configuration mode from Operational mode, use the configure command:
username@hostname> configure
Entering configuration mode
[edit]
username@hostname#
To leave Configuration mode and return to Operational mode, use the quit or exit command:
username@hostname# quit
Exiting configuration mode
username@hostname>
To enter an Operational mode command while in Configuration mode, use the run command, as
described in run on page 50.
To direct an Operational mode command to a particular VSYS, specify the target VSYS with the
following command:
username@hostname# set system setting target-vsys <vsys_name>
Introduction 17
To display the available options for a specified command, enter the command followed by ?.
Example:
@localhost> ping ?
username@hostname> ping
+ bypass-routing
Bypass routing table, use specified interface
+ count
Number of requests to send (1..2000000000 packets)
+ do-not-fragment Don't fragment echo request packets (IPv4)
+ inet
Force to IPv4 destination
+ interface
Source interface (multicast, all-ones, unrouted
packets)
+ interval
Delay between requests (seconds)
+ no-resolve
Don't attempt to print addresses symbolically
+ pattern
Hexadecimal fill pattern
+ record-route
Record and report packet's path (IPv4)
+ size
Size of request packets (0..65468 bytes)
+ source
Source address of echo request
+ tos
IP type-of-service value (0..255)
+ ttl
IP time-to-live value (IPv6 hop-limit value) (0..255
hops)
+ verbose
Display detailed output
+ wait
Delay after sending last packet (seconds)
<host>
Hostname or IP address of remote host
username@hostname> ping
18 Introduction
Description
>
There are additional command options for this command at this level.
There is an option to specify an except value or a match value to restrict the command.
Example: This command output shows options designated with + and >.
username@hostname# set
+ action
+ application
+ destination
+ disabled
+ from
+ log-end
+ log-setting
+ log-start
+ negate-destination
+ negate-source
+ schedule
+ service
+ source
+ to
> profiles
<Enter>
[edit]
username@hostname# set
Introduction 19
Example:
The following sample output is for the show system info command:
username@hostname> show system info
hostname: PA-HDF
ip-address: 10.1.7.10
netmask: 255.255.0.0
default-gateway: 10.1.0.1
mac-address: 00:15:E9:2E:34:33
time: Fri Aug 17 13:51:49 2007
uptime: 0 days, 23:19:23
devicename: PA-HDF
family: i386
model: pa-4050
serial: unknown
sw-version: 1.5.0.0-519
app-version: 25-150
threat-version: 0
url-filtering-version: 0
logdb-version: 1.0.8
username@hostname>
20 Introduction
Description
superuser
Has full access to the firewall and can define new administrator accounts and virtual
systems.
superreader
vsys
vsysreader
device
Has full access to a selected device, except for defining new accounts or virtual systems.
devicereader
ethernet1/15
11
13
15
10
12
14
16
ethernet1/2
ethernet1/16
Introduction 21
22 Introduction
Chapter 2
save commandSaves the candidate configuration in firewall non-volatile storage. The saved
configuration is retained until overwritten by subsequent save commands. Note that this command
does not make the configuration active.
command)
(enter a configuration
[edit]
username@hostname# save config to snapshot.xml
Config saved to .snapshot.xml
[edit]
username@hostname#
Note: If you exit Configuration mode without issuing the save or commit
command, your configuration changes could be lost if power is lost to the firewall.
Active
Configuration
Saved
Configuration
Candidate
Configuration
Commit
Save
Load
Set
Maintaining a candidate configuration and separating the save and commit steps confers important
advantages when compared with traditional CLI architectures:
Distinguishing between the save and commit concepts allows multiple changes to be made at the
same time and reduces system vulnerability.
For example, if you want to remove an existing security policy and add a new one, using a
traditional CLI command structure would leave the system vulnerable for the period of time
between removal of the existing security policy and addition of the new one. With the PAN-OS
approach, you configure the new security policy before the existing policy is removed, and then
implement the new policy without leaving a window of vulnerability.
> ocsp-responder
ocsp-responder
> pdf-summary-report
pdf-summary-report
> profile-group
profile-group
> profiles
profiles
> region
region
> report-group
report-group
> reports
reports
> response-page
response-page
> rulebase
rulebase
> schedule
schedule
> server-profile
server-profile
> service
service
> service-group
service-group
> setting
setting
> ssl-decrypt
ssl-decrypt
> threats
threats
> ts-agent
ts-agent
> url--override
url--override
> url-content-types
url-content-types
> user-id-agent
user-id-agent
> user-id-agent-sequence
user-id-agent-sequence
> user-id-collector
user-id-collector
> zone
zone
<Enter>
Finish input
profiles interface
vlan
...
...
ethernet
virtual-wire virtual-router
...
aggregate-ethernet
vlan
...
ethernet1/1
link-duplex
auto
...
...
ethernet1/2
ethernet1/3 ethernet1/4
link-state
up
virtual-wire link-speed
1000
loopback
...
This command generates a new element in the hierarchy, as shown in Figure 4 and in the output of the
following show command:
[edit]
username@hostname# show network interface ethernet ethernet1/4
ethernet1/4 {
layer3 {
ip {
10.1.1.12/24;
}
}
}
[edit]
username@hostname#
network
profiles interface
vlan
...
...
ethernet
virtual-wire virtual-router
...
...
aggregate-ethernet
vlan
...
ethernet1/1
ethernet1/2
...
loopback
...
ethernet1/3 ethernet1/4
ip
10.1.1.12/24
indicates that the relative context is the top level of the hierarchy, whereas
[edit network profiles]
Use the commands listed in Table 3 to navigate through the configuration hierarchy.
Description
edit
up
top
level)
[edit network]
level)
(network level)
Note: The set command issued after using the up and top commands starts from
the new context.
Monitoring and troubleshootingPerform diagnosis and analysis. Includes debug and ping
commands.
Display commandsDisplay or clear current information. Includes clear and show commands.
PAN-OS CLI navigation commandsEnter Configure mode or exit the PAN-OS CLI. Includes
configure, exit, and quit commands.
System commandsMake system-level requests or restart. Includes set and request commands.
XML option:
username@hostname# show system log-export-schedule
<log-export-schedule>
<entry name="10.16.0.97">
<description>10.16.0.97</description>
<enable>yes</enable>
<log-type>threat</log-type>
<start-time>03:00</start-time>
<protocol>
<ftp>
<hostname>10.16.0.97</hostname>
<port>21</port>
<passive-mode>yes</passive-mode>
<username></username>
<password>mZDB7rbW5y8=</password>
</ftp>
</protocol>
</entry>
</log-export-schedule>
[edit deviceconfig]
[edit deviceconfig]
username@hostname#
system log-export-schedule
log-export-schedule 10.16.0.97
log-export-schedule 10.16.0.97
log-export-schedule 10.16.0.97
log-export-schedule 10.16.0.97
log-export-schedule 10.16.0.97
description 10.16.0.97
enable yes
log-type threat
start-time 03:00
protocol ftp hostname
Chapter 3
check on page 37
commit on page 38
copy on page 39
delete on page 40
edit on page 41
exit on page 42
find on page 43
load on page 44
move on page 46
override on page 47
quit on page 48
rename on page 49
run on page 50
save on page 51
up on page 297
Changes in the configuration are retained, until overwritten, while the firewall is
powered. To save a candidate configuration in non-volatile storage, use the save
command. To make a candidate configuration active, use the commit command.
check
check
Displays the current configuration status.
Syntax
check
{
data-access-passwd {system} |
pending-changes
}
Options
> data-access-passwd Check data access authentication status for this session
+ system Check whether data access password exists for the system
> pending-changes Check for uncommitted changes
Sample Output
The following command shows that there are currently no uncommitted changes.
username@hostname# check pending-changes
no
[edit]
username@hostname#
commit
commit
Makes the current candidate configuration the active configuration on the firewall.
When you change a configuration setting, the current candidate configuration is
updated, not the active configuration. The commit command applies the candidate
configuration to the active configuration, which activates all configuration
changes since the last commit.
Syntax
commit {force}
{
partial device-and-network excluded |
partial policy-and-objects excluded |
partial vsys <value> |
partial no-vsys
}
Options
> force Forces the commit command in the event of a conflict
> partial Commits the specified part of the configuration
+ device-and-network Excludes device and network configurations from the commit (configurations under config/mgtconfig, config/devices/platform, config/devices/deviceconfig, and config/devices/network)
+ policy-and-object Excludes policy and object configurations from the commit (configurations under (config/shared; also
excludes config/devices/vsys if in single vsys mode)
+ vsys Commits only the specified virtual system configurations
> no-vsys Excludes all virtual systems from the commit (configurations under config/devices/vsys)
Sample Output
The following command updates the active configuration with the contents of the candidate configuration.
username@hostname# commit
copy
copy
Makes a copy of a node in the hierarchy along with its children, and adds the copy to the same hierarchy level.
Syntax
copy <node1> to <node2>
Options
<node1> Specifies the node to be copied
<node2> Specifies the name of the copy
Sample Output
The following command, executed from the rule base security level of the hierarchy, makes a copy of rule1, called
rule2.
[edit rulebase security]
username@hostname# copy rules rule1 to rule2
[edit rulebase security]
username@hostname#
The following command shows the location of the new rule in the hierarchy.
[edit rulebase security]
username@hostname# show
security {
rules {
rule1 {
source [ any 1.1.1.1/32 ];
destination 1.1.1.2/32;
}
rule2 {
source [ any 1.1.1.1/32 ];
destination 1.1.1.2/32;
}
}
}
delete
delete
Removes a node from the candidate configuration along with all its children.
No confirmation is requested when this command is entered.
Syntax
delete <node>
Options
<node> Specifies the node to be deleted. For available nodes of the hierarchy, press <tab>.
Sample Output
The following command deletes the application myapp from the candidate configuration.
username@hostname# delete application myapp
[edit]
username@hostname#
edit
edit
Changes context to a lower level in the configuration hierarchy.
Syntax
edit <context>
Options
<context> Specifies a path through the hierarchy. For available contexts in the hierarchy, press <tab>.
Sample Output
The following command changes context from the top level to the network profiles level of the hierarchy.
[edit]
username@hostname# edit rulebase
[edit rulebase]
username@hostname#
exit
exit
Exits from the current PAN-OS CLI level.
From Configuration mode, top hierarchy level Exits Configuration mode, returning to Operational mode.
From Configuration mode, lower hierarchy levels Changes context to one level up in the hierarchy. Provides
the same result as the up command.
The exit command is the same as the quit command.
Syntax
exit
Options
None
Sample Output
The following command changes context from the network interface level to the network level.
[edit network interface]
username@hostname# exit
[edit network]
username@hostname#
find
find
Lists CLI commands containing the specified keyword.
Syntax
find command keyword <value>
Options
<value> Specifies a keyword.
Sample Output
The following command lists all CLI commands containing the keyword hsm.
username@hostname# find command keyword hsm
set profiles decryption <name> ssl-inbound-proxy block-if-hsm-unavailable <yes|no>
set profiles decryption <name> ssl-forward-proxy block-if-hsm-unavailable <yes|no>
username@hostname#
load
load
Assigns the last saved configuration, or a specified configuration, to be the candidate configuration. Also, loads the
last imported device state files.
Syntax
load
{
config |
{
key <value> |
from <filename> |
last-saved |
partial |
{
from <filename> |
from-xpath <value> |
mode {merge | replace} |
to-xpath <value>
}
repo device <value> {file <value> | version <value>} |
version <value>
}
device-state
}
Options
> config Loads specified configuration
+ key Key used for encryption
> from File name (select from the file names provided, or enter a new name)
> last-saved Loads the last saved configuration
> partial Loads partial configuration
* from File name (select from the file names provided, or enter a new name)
* from-xpath XML Path (XPath) of the source node
* mode Mode in which to load (merge or replace)
* to-xpath XML Path (XPath) of the destination's parent
> repo Loads device config from backup repository
* device Device name
> file Filename
> version Version
> version Selects from the provided versions
> device-state Loads from imported device state files to GlobalProtect Portals.
load
Sample Output
The following command assigns output.xml to be the candidate configuration.
[edit]
username@hostname# load config from output.xml
command succeeded
[edit]
username@hostname#
The following command adds the top-apps report found in the x.xml configuration to the specified candidate
configuration.
[edit]
username@hostname# load config partial from x.xml from-xpath shared/reports/
entry[@name='top-apps'] mode merge to-xpath/config/devices/
entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1']/reports
command succeeded
[edit]
username@hostname#
move
move
Relocates a node in the hierarchy along with its children to be at another location at the same hierarchy level.
Syntax
move <element1> {bottom | top | after <element2> | before <element2>}
Options
<element1> Specifies the items to be moved. For available elements of the hierarchy, press <tab>.
<element2> Indicates the element after or before which element1 will be placed
after Moves element to be after element2
before Moves element to be before element2
bottom Makes the element the last entry of the hierarchy level
top Makes the element the first entry of the hierarchy level
Sample Output
The following command moves the security rule rule1 to the top of the rule base.
username@hostname# move rulebase security rules rule1 top
[edit]
username@hostname#
override
override
Overrides a node from the candidate configuration along with all its children. This is a device command that
overrides a value pushed from a Panorama Template.
No confirmation is requested when this command is entered.
Syntax
override <node>
Options
<node> Specifies the node to override. For available nodes of the hierarchy, press <tab>.
Sample Output
The following command overrides the group mapping mygroup from the candidate configuration.
username@hostname# override group-mapping mygroup
[edit]
username@hostname#
quit
quit
Exits from the current PAN-OS CLI level.
From Configuration mode, top hierarchy level Exits Configuration mode, returning to Operational mode.
From Configuration mode, lower hierarchy levels Changes context to one level up in the hierarchy. Provides
the same result as the up command.
The exit and quit commands are interchangeable.
Syntax
quit
Options
None
Sample Output
The following command changes context from the network interface level to the network level.
[edit log-settings]
username@hostname# quit
[edit]
username@hostname#
rename
rename
Changes the name of a node in the hierarchy.
Syntax
rename <node1> to <node2>
Options
<node1> Indicates the original node name. For available nodes of the hierarchy, press <tab>.
<node2> Indicates the new node name
Sample Output
The following command changes the name of a node in the hierarchy from 1.1.1.1/24 to 1.1.1.2/24.
username@hostname# rename network interface vlan ip 1.1.1.1/24 to 1.1.1.2/24
run
run
Executes an Operational mode command while in Configuration mode.
For information about the syntax and options for each Operational mode command, refer to its command page in
Chapter 4, Operational Mode Commands.
Syntax
run
{
check |
clear |
commit |
commit-all |
debug |
delete |
diff-all |
ftp |
grep |
less |
load |
ls |
netstat |
ping |
request |
save |
schedule |
scp |
set |
show |
ssh |
tail |
target |
tcpdump |
test |
tftp |
traceroute |
view-pcap
}
Sample Output
The following command executes a ping command to the IP address 1.1.1.2 from Configuration mode.
username@hostname# run ping host 1.1.1.2
PING 1.1.1.1 (1.1.1.1) 56(84) bytes of data.
...
username@hostname#
save
save
Saves a snapshot of the firewall configuration or the device state files from a GlobalProtect Portal.
This command saves the configuration on the firewall, but does not make the
configuration active. Use the commit command to make the current candidate
configuration active.
Syntax
save
{
config to <filename> |
device-state
}
Options
> config Saves the current configuration
+ to File name (select from the file names provided, or enter a new name)
> device-state Saves all files needed to restore a GlobalProtect Portal. This command is used to save the configuration and
dynamic information from a firewall that is configured as a GlobalProtect Portal with the large scale VPN feature enabled.
The file can then be imported to restore the Portal in the event of a failure. The export contains a list of all satellite devices
managed by the Portal, the running configuration at the time of the export, and all certificate information (Root CA, Server,
and Satellite certificates).
Sample Output
The following command saves a copy of the configuration to the file savefile.
[edit]
username@hostname# save config to savefile
Config saved to savefile
[edit]
username@hostname#
set address
set address
Specifies addresses and address ranges for use in security policies. Addresses requiring the same security settings can
be combined into address groups that you can refer to as a unit.
For information on configuring address groups using the CLI, refer to set address-group on page 53.
Syntax
set address <name> |
{
description <value> |
fqdn <value> |
ip-netmask <ip/netmask> |
ip-range <ip_range>
tag <value>
}
Options
<name> Select from the local server list or enter a name for the address (up to 63 characters)
+ description Address description value
> fqdn Fully Qualified Domain Name (FQDN) value
> ip-netmask IP address and network mask (x.x.x.x/y or IPv6/netmask)
> ip-range IP address range (x.x.x.x-y.y.y.y or IPv6-range)
> tag Tags for address object (Select values from the local server list, or enter a name or group of names enclosed in [ ])
set address-group
set address-group
Configures sets of addresses that will be assigned the same security settings, to simplify the creation of security
policies.
For information on configuring address groups using the CLI, refer to set address on page 52.
Syntax
set address-group <name> |
{
description <value> |
dynamic {filter <value>} <value> |
static <list of values> |
tag <list of values>
}
Options
<name> Select from the local server list or enter a name for the address group (up to 63 characters)
+ description Address group description
> dynamic Dynamic addressing
> static static addressing
> tag Tags for address object (Select values from the local server list, or enter a name or group of names enclosed in [ ])
set application
set application
Creates a custom App-ID for use throughout PAN-OS wherever an application can be specified.
Syntax
set application <name> |
{
able-to-transfer-file {no | yes} |
alg-disable-capability <value> |
category {business-systems | collaboration | general-internet | media | networking |
<value>} |
consume-big-bandwidth {no | yes} |
data-ident {no | yes} |
description <value> |
evasive-behavior {no | yes} |
file-type-ident {no | yes} |
has-known-vulnerability {no | yes} |
parent-app <value> |
pervasive-use {no | yes} |
prone-to-misuse {no | yes} |
risk <value> |
spyware-ident {no | yes} |
subcategory <value> |
tcp-timeout <value> |
technology {browser-based | client-server | network-protocol | peer-to-peer|
<value>} |
timeout <value> |
tunnel-applications {no | yes} |
tunnel-other-application {no | yes} |
udp-timeout <value> |
used-by-malware {no | yes} |
virus-ident {no | yes} |
default |
{
ident-by-icmp-type <value> |
ident-by-icmp6-type <value> |
ident-by-ip-protocol <value> |
port <value> |
}
signature <name>
{
comment <value> |
order-free {no | yes} |
scope {protocol-data-unit | session} |
and-condition <name> {or-condition <name>}
{
operator equal-to |
{
context {unknown-req-tcp | unknown-req-udp | unknown-rsp-tcp | unknown-rspudp}
mask <value> |
set application
position <value> |
value <value>
}
operator pattern-match
{
context <value> |
pattern <value> |
qualifier <name> value <value>
}
}
}
}
Options
<name> Enter a name for the application
+ able-to-transfer-file Able to transfer files
+ alg-disable-capability Disable the Application-level Gateway (ALG)
+ category Category; select from business-systems, collaboration, general-internet, media, networking, or enter a value
+ consume-big-bandwidth Consumes big bandwidth
+ data-ident Data identification
+ description Description value
+ evasive-behavior Has evasive behavior
+ file-type-ident File type identification
+ has-known-vulnerability Has known vulnerability
+ parent-app Parent application; select from list or enter a value
+ pervasive-use Pervasively used
+ prone-to-misuse Prone to misuse
+ risk Risk value (1-5)
+ spyware-ident Spyware identification
+ subcategory Subcategory; select from the list or enter a value
- business-systems subcategories are auth-service, database, erp-crm, general-business, management, office-programs,
software-update, or storage-backup
- collaboration subcategories are email, instant-messaging, internet-conferencing, social-networking, voip-video, or webposting
- general-internet subcategories are file-sharing or internet-utility
- media subcategories are audio-streaming, gaming, or photo-video
- networking subcategories are encrypted-tunnel, infrastructure, ip-protocol, proxy, remote-access. or routing
+ tcp-timeout TCP timeout in seconds (0-604800); setting to 0 applies the default timeout
+ technology Technology; select from browser-based, client-server, network-protocol, peer-to-peer, or enter a value
+ timeout Timeout in seconds (0-604800); setting to 0 applies the default timeout
+ tunnel-applications Tunnel applications
+ tunnel-other-application Tunnel other applications
+ udp-timeout UDP timeout in seconds (0-604800); setting to 0 applies the default timeout
+ used-by-malware Used by malware
+ virus-ident Virus identification
> default Default application
> ident-by-icmp-type Identification by ICMP type (0-255,...)
> ident-by-icmp6-type Identification by ICMP6 type (0-255,...)
> ident-by-ip-protocol Identification by IP protocol (0-255,...)
> port Protocol port specification : {tcp|udp}/{dynamic|port range list} (e.g. tcp/8080, tcp/80,443, tcp/1-1024,10000, udp/
dynamic), or list of values enclosed in [ ]
> signature Signature application
+ comment Comment value
+ order-free Order free (no or yes)
+ scope Scope (protocol data unit transaction or session)
set application
Sample Output
The following command configures an application that detects web traffic going to a specified website.
username@hostname# set application specifiedsite category collaboration subcategory
social-networking technology browser-based signature s1 and-condition a1 orcondition o1 operator pattern-match context http-req-host-header pattern
www.specifiedsite.com
username@hostname#
The following example demonstrates configuring an application that detects blog posting activity on a specified blog.
username@hostname# set application specifiedblog_posting category collaboration
subcategory web-posting technology browser-based signature s1 and-condition a1 orcondition o1 operator pattern-match context http-req-host-header pattern
specifiedblog.com qualifier http-method value POST
username@hostname# set application specifiedblog_posting category collaboration
subcategory web-posting technology browser-based signature s1 and-condition a2 orcondition o2 operator pattern-match context http-req-params pattern post_title
qualifier http-method value POST
username@hostname# set application specifiedblog_posting category collaboration
subcategory web-posting technology browser-based signature s1 and-condition a3 orcondition o3 operator pattern-match context http-req-params pattern post_author
qualifier http-method value POST
username@hostname#
set application-filter
set application-filter
Specifies application filters to simplify repeated searches.
Syntax
set application-filter <name>
{
category {business-systems | collaboration | general-internet | media | networking |
unknown | <member_value>} |
evasive yes |
excessive-bandwidth-use yes |
has-known-vulnerabilities yes |
pervasive yes |
prone-to-misuse yes |
risk <value> |
subcategory <member_value> |
technology {browser-based | client-server | network-protocol | peer-to-peer|
<member_value>} |
transfers-files yes |
tunnels-other-apps yes |
used-by-malware yes
}
Options
<name> Enter a name for the application filter
+ category Category; select from business systems, collaboration, general internet, media, networking, unknown, or enter a
value or list of values enclosed in [ ]
+ evasive Configure to filter for evasive applications
+ excessive-bandwidth-use Configure to filter for excessive bandwidth use
+ has-known-vulnerabilities Configure to filter for applications with known vulnerabilities
+ pervasive Configure to filter for pervasive applications
+ prone-to-misuse Configure to filter for applications prone to misuse
+ risk Risk value (1-5)
+ subcategory Subcategory; select from the list or enter a value or list of values enclosed in [ ]
- business-systems subcategories are auth-service, database, erp-crm, general-business, management, office-programs,
software-update, or storage-backup
- collaboration subcategories are email, instant-messaging, internet-conferencing, social-networking, voip-video, or webposting
- general-internet subcategories are file-sharing or internet-utility
- media subcategories are audio-streaming, gaming, or photo-video
- networking subcategories are encrypted-tunnel, infrastructure, ip-protocol, proxy, remote-access. or routing
- unknown subcategories include all of the above
+ technology Technology; select from browser-based, client-server, network-protocol, peer-to-peer, or enter a value or list of
values enclosed in [ ]
+ transfers-files Configure to filter for applications that transfer files
+ tunnels-other-apps Configure to filter for applications that tunnel other applications
+ used-by-malware Configure to filter for applications used by malware
set application-group
set application-group
Specifies a set of applications that require the same security settings, to simplify the creation of security policies.
For information on enabling application settings using the CLI, refer to set application on page 54.
Syntax
set application-group <name> <member_value>
Options
<name> Enter a name for the application group
<value> Select from the list of predefined applications, filters, and groups, or enter a value or list of values enclosed in [ ]
set captive-portal
set captive-portal
Configures a captive portal on the firewall. You can set up and customize a captive portal to direct user authentication
by way of an authentication profile or authentication sequence. Captive portal is used in conjunction with the UserID Agent to extend user identification functions beyond the Active Directory domain. Users are directed to the portal
and authenticated, thereby creating a user-to-IP address mapping
Syntax
set captive-portal
{
authentication-profile <value> |
client-certificate-profile <value> |
enable-captive-portal {no | yes} |
idle-timer <value> |
redirect-host {<ip/netmask> | <host_name>} |
server-certificate <value> |
timer <value> |
mode |
{
redirect |
{
session-cookie
{
enable {no | yes} |
roaming {no | yes} |
timeout <value>
}
}
transparent
}
ntlm-auth
{
attempts <value> |
reversion-time <value> |
timeout <value>
}
}
Options
+ authentication-profile Authentication profile name
+ client-certificate-profile Profile for authenticating client certificates
+ enable-captive-portal Enable the captive portal
+ idle-timer Idle timer in minutes (1-1440)
+ redirect-host IP address/network mask or host name for redirect for NTLM or captive portal
+ server-certificate SSL server certificate file name
+ timer Expiration timer in minutes (1-1440)
> mode Captive portal mode
> redirect Redirect configuration
> session-cookie Session cookie configuration
+ enable Enable session cookie
set captive-portal
set device-group
set device-group
(Panorama only) Configures device groups for management by Panorama.
For information about the syntax and options for each configuration available for device groups, refer to its command
page in this chapter.
Syntax
set device-group <name>
{
description <value> |
address |
address-group |
application |
application-filter |
application-group |
devices <serial_number> {vsys <name>} |
external-list |
log-settings |
master-device {device <name> | vsys <name>} |
post-rulebase |
pre-rulebase |
profile-group |
profiles |
region |
schedule |
service |
service-group |
threats |
}
Options
+ description Device group description text
> address [refer to set address on page 52]
> address-group [refer to set address-group on page 53]
> application [refer to set application on page 54]
> application-filter [refer to set application-filter on page 57]
> application-group [refer to set application-group on page 58]
> devices Device serial numbers
> vsys Option to specify a virtual system
> external-list [refer to set external-list on page 94]
> log-settings [refer to set shared log-settings on page 258]
> master-device Device from which user and user groups will be retrieved
+ device Master device name
+ vsys Virtual system name
> post-rulebase [refer to set shared post-rulebase on page 265]
> pre-rulebase [refer to set shared pre-rulebase on page 266]
> profile-group [refer to set profile-group on page 196]
> profiles [refer to set profiles on page 197]
> region [refer to set region on page 213]
> schedule [refer to set schedule on page 231]
set device-group
Syntax
set deviceconfig
{
high-availability {
enabled yes|no;
interface {
ha1 {
port <value>;
link-speed auto|10|100|1000;
link-duplex auto|full|half;
encryption {
enabled yes|no;
}
ip-address <ip/netmask>;
netmask <value>;
gateway <ip/netmask>;
monitor-hold-time 1000-60000;
}
ha1-backup {
port <value>;
link-speed auto|10|100|1000;
link-duplex auto|full|half;
ip-address <ip/netmask>;
netmask <value>;
gateway <ip/netmask>;
}
ha2 {
port <value>;
link-speed auto|10|100|1000;
link-duplex auto|full|half;
ip-address <ip/netmask>;
netmask <value>;
gateway <ip/netmask>;
}
ha2-backup {
port <value>;
link-speed auto|10|100|1000;
link-duplex auto|full|half;
ip-address <ip/netmask>;
netmask <value>;
gateway <ip/netmask>;
}
ha3 {
port <value>;
}
}
group {
REPEAT...
<name> {
description <value>;
election-option {
device-priority 0-255;
preemptive yes|no;
heartbeat-backup yes|no;
timers {
recommended;
OR...
aggressive;
OR...
advanced {
promotion-hold-time 0-60000;
hello-interval 8000-60000;
heartbeat-interval 1000-60000;
flap-max 0-16;
preemption-hold-time 1-60;
monitor-fail-hold-up-time 0-60000;
additional-master-hold-up-time 0-60000;
}
}
}
peer-ip <ip/netmask>;
peer-ip-backup <ip/netmask>;
state-synchronization {
enabled yes|no;
transport ethernet|ip|udp;
ha2-keep-alive {
enabled yes|no;
action log-only|split-datapath;
threshold 5000-60000;
}
}
configuration-synchronization {
enabled yes|no;
}
mode {
active-passive {
passive-link-state shutdown|auto;
monitor-fail-hold-down-time 1-60;
}
OR...
active-active {
device-id 0|1;
tentative-hold-time 10-600;
network-configuration {
sync {
virtual-router yes|no;
qos yes|no;
}
}
virtual-address {
REPEAT...
<name> {
ip {
REPEAT...
<name> {
floating {
device-priority {
device-0 0-255;
device-1 0-255;
failover-on-link-down yes|no;
}
}
OR...
arp-load-sharing {
ip-modulo;
OR...
ip-hash {
hash-seed 0-4294967295;
}
}
}
}
ipv6 {
REPEAT...
<name> {
floating {
device-priority {
device-0 0-255;
device-1 0-255;
failover-on-link-down yes|no;
}
}
OR...
arp-load-sharing {
ip-modulo;
OR...
ip-hash {
hash-seed 0-4294967295;
}
}
}
}
}
}
session-owner-selection {
primary-device;
OR...
first-packet {
session-setup {
primary-device;
OR...
first-packet;
OR...
ip-modulo;
OR...
ip-hash {
hash-key source|source-and-destination;
hash-seed 0-4294967295;
}
}
}
}
}
}
monitoring {
path-monitoring {
enabled yes|no;
failure-condition any|all;
path-group {
virtual-wire {
REPEAT...
<name> {
enabled yes|no;
failure-condition any|all;
source-ip <ip/netmask>;
destination-ip [ <destination-ip1> <destination-ip2>... ];
ping-interval 200-60000;
ping-count 3-10;
}
}
vlan {
REPEAT...
<name> {
enabled yes|no;
failure-condition any|all;
source-ip <ip/netmask>;
destination-ip [ <destination-ip1> <destination-ip2>... ];
ping-interval 200-60000;
ping-count 3-10;
}
}
virtual-router {
REPEAT...
<name> {
enabled yes|no;
failure-condition any|all;
destination-ip [ <destination-ip1> <destination-ip2>... ];
ping-interval 200-60000;
ping-count 3-10;
}
}
}
}
link-monitoring {
enabled yes|no;
failure-condition any|all;
link-group {
REPEAT...
<name> {
enabled yes|no;
failure-condition any|all;
interface [ <interface1> <interface2>... ];
}
}
}
}
}
}
}
}
}
Options
> high-availability
+ enabled enabled (no or yes)
> group HA group configuration
<value> Group number (between 1 and 63)
+ description group description
+ peer-ip Peer IP address
+ peer-ip-backup Backup Peer IP address
> configuration-synchronization Configuration synchronization
> election-option HA election options
+ device-priority highest = 0, lowest = 255, default = 100
+ heartbeat-backup Use management port as backup path for heartbeat messages
+ hello-interval Interval in milliseconds to send Hello messages (8000-60000 ms), default = 8000
+ preemptive Configure on both HA peers to allow preemption by Passive or Active-Secondary device based on
device-priority, default = no
> timers Configure timers for high-availability
> Advanced
+ additional-master-hold-up-time Interval in milliseconds to wait before honoring a path or link monitor
failure on the Active or Active-Primary device, default 500
+ flap-max Flaps before entering suspended state, 0 = infinite flaps, default 3
+ heartbeat-interval Interval in milliseconds to send Heartbeat pings, default 1000
+ hello-interval Interval in milliseconds to send Hello messages, default 8000
+ monitor-fail-hold-up-time Interval in milliseconds to wait before honoring a path or link monitor
failure on this device, default 0
+ preemption-hold-time Interval in minutes to stay Passive before preempting Active device or to stay
Active-Secondary before preempting Active-Primary device, default 1
+ promotion-hold-time Interval in milliseconds to state change from Passive to Active or ActiveSecondary to Active-Primary, default 2000
+ Aggressive Use aggressive HA timer settings
+ Recommended Use recommended HA timer settings
> mode Operational mode configuration
> active-active Active-Active mode
+ device-id Device ID in HA group, 0 or 1
+ packet-forwarding Forward packet via HA3 link if session is owned by peer device (no or yes)
> network-configuration Network configuration synchronization options
> sync Synchronization options
+ qos Synchronize interface QoS configuration
+ virtual-router Synchronize virtual router configuration
> tentative-hold-time Number of seconds that the firewall will remain in the tentative state if a failure occurs
in an active/active configuration. During the tentative period the firewall will attempt to build routing
adjacencies and populate its route table before it will process any packets (10-600; default = 60)
> session-owner-selection Firewall session owner selection options
> first-packet Session is owned by the device that receives the first packet of the session
> session-setup Session setup load-sharing options
> ip-hash Use hashing on source and destination addresses
+ hash-key Address(es) to use as hash key
- source Source address only
- source-and-destination Source and destination addresses
+ hash-seed User-specified hash seed (between 0 and 4294967295)
- ip-modulo Use modulo operations on source and destination addresses
- primary-device Use Active-Primary device to setup session
- primary-device Session is owned by the device in Active-Primary state
> virtual-address Virtual address configuration (Layer 3 interface name)
> ip Interface virtual IP address (IP/netmask or address object)
> arp-load-sharing ARP-based load-sharing
> ip-hash Hash based on IP address
+ hash-seed User-specified hash seed
- ip-modulo IP address modulo number of devices, default option
> floating Floating address bound to one virtual device at any given time
> device-priority Virtual device priority
+ device-0 Device 0 priority, highest: 0, lowest: 255
+ device-1 Device 1 priority, highest: 0, lowest: 255
+ failover-on-link-down Failover address if link state is down (no or yes)
> ipv6 Interface virtual IPv6 address (IP/netmask or address object)
> arp-load-sharing ARP-based load-sharing
> ip-hash Hash based on IP address
+ hash-seed User-specified hash seed
- ip-modulo IP address modulo number of devices, default option
> floating Floating address bound to one virtual device at any given time
> device-priority Virtual device priority
+ device-0 Device 0 priority, highest: 0, lowest: 255
+ device-1 Device 1 priority, highest: 0, lowest: 255
+ failover-on-link-down Failover address if link state is down (no or yes)
> active-passive Active-Passive mode
+ monitor-fail-hold-down-time Interval in minutes to stay in non-functional state following a link/path
monitor failure (between 1 and 60); default = 1
+ passive-link-state Link mode of data-plane interfaces while in Passive state
- auto Link put into automatically configured mode
- shutdown Link put into powered off state
> monitoring Monitoring configuration
> link-monitoring Link monitoring configuration
+ enabled Link monitoring enabled
+ failure-condition Condition to determine failure, default = any (failure on any link group)
> link-group Monitored link group configuration
+ interface - Interface(s) to monitor (member value or list of values enclosed in [ ])
> path-monitoring Path monitoring configuration
+ enabled Path monitoring enabled
+ failure-condition Condition to determine failure, default = any (failure on any path group)
> path-group Monitored path group
> virtual-router Monitor within virtual-router (alpha-numeric string [a-zA-Z0-9:@./_-])
+ destination-ip Destination IP addresses to monitor
+ enabled Monitoring enabled
+ failure-condition Condition to determine failure, default = any (failure on any monitored IP)
Syntax
set deviceconfig
{
setting |
{
application |
{
bypass-exceed-queue {no | yes} |
cache {no | yes} |
cache-threshold <value> |
dump-unknown {off | on} |
heuristics {no | yes} |
identify-unknown-traffic-by-port {no | yes} |
notify-user {no | yes} |
supernode {no | yes} |
use-cache-for-identification {no | yes} |
traceroute {no | yes} |
{
enable {no | yes} |
ttl-threshold <value>
}
}
config rematch {no | yes} |
ctd |
{
tcp-bypass-exceed-queue {no | yes} |
udp-bypass-exceed-queue {no | yes} |
cap-portal-ask-timeout <value> |
cap-portal-max-session <value> |
extended-capture-segment <value> |
http-proxy-use-transaction {no | yes} |
skip-block-http-range {no | yes} |
strip-x-fwd-for {no | yes} |
url-admin-timeout <minutes> |
url-coach-timeout <minutes> |
url-lockout-timeout <minutes> |
url-wait-timeout <seconds> |
x-forwarded-for {no | yes}
}
custom-logo |
{
hide-panorama-header-background {no | yes} |
login-screen {content <value> | file-name <value>} |
main-ui {content <value> | file-name <value>} |
pdf-report-footer {content <value> | file-name <value>} |
pdf-report-header {content <value> | file-name <value>}
}
threat-pcaps <value> |
thsum <value> |
traffic <value> |
trsum <value> |
userid <value> |
weeklythsum <value> |
weeklytrsum <value> |
}
mgmt-card
{
alarm <value> |
application-pcaps <value> |
appstat <value> |
config <value> |
debug-filter-pcaps <value> |
dlp-logs <value> |
hip-reports <value> |
system <value> |
}
common-criteria-alarm-generation |
{
enable-alarm-generation {no | yes} |
enable-audible-alarms {no | yes} |
enable-cli-alarm-notification {no | yes} |
enable-web-alarm-notification {no | yes} |
encrypt-decrypt-fail-count <value> |
log-databases-alarm-threshold {alarm | config | hipmatch | system | threat
| traffic} <value>
rule-group-limits {count <value> | tags <value> | time-interval <value>} |
security-policy-limits {count <value> | time-interval <value>}
}
disable-predefined-report <value> |
disk-quota |
{
alarm <value> |
application-pcaps <value> |
appstat <value> |
config <value> |
dailythsum <value> |
dailytrsum <value> |
debug-filter-pcaps <value> |
dlp-logs <value> |
hip-reports <value> |
hipmatch <value> |
hourlythsum <value> |
hourlytrsum <value> |
system <value> |
threat <value> |
threat-pcaps <value> |
thsum <value> |
traffic <value> |
trsum <value> |
userid <value>|
weeklythsum <value> |
weeklytrsum <value>
}
log-forwarding-from-device {buffered {no | yes}} |
storage-partition
{
nfsv3 {copy-on-setup {no | yes} | log-directory <value> | port <value> |
protocol {tcp | udp} | read-size <value> | server <value> | write-size
<value>}
internal
}
}
nat |
{
reserve-ip {no | yes} |
reserve-time <seconds>
}
nat64 ipv6-min-network-mtu <value> |
packet ip-frag-limit {no | yes} |
pow |
{
wqe-inuse-check {no | yes} |
wqe-swbuf-check {no | yes} |
wqe-swbuf-ref {no | yes} |
wqe-tag-check {no | yes}
}
session |
{
accelerated-aging-enable {no | yes} |
accelerated-aging-scaling-factor <value> |
accelerated-aging-threshold <value> |
ipv6-firewalling {no | yes} |
offload {no | yes} |
resource-limit-behavior {bypass | drop} |
scan-scaling-factor <value> |
scan-threshold <value> |
tcp-reject-non-syn {no | yes} |
timeout-captive-portal <value> |
timeout-default <value> |
timeout-discard-default <value> |
timeout-discard-tcp <value> |
timeout-discard-udp <value> |
timeout-icmp <value> |
timeout-scan <value> |
timeout-tcp <value> |
timeout-tcp-half-closed <value> |
timeout-tcp-time-wait <value> |
timeout-tcp-unverified-rst <value> |
timeout-tcphandshake <value> |
timeout-tcpinit <value> |
timeout-udp <value>
}
ssl-decrypt |
{
answer-timeout <seconds> |
zip
{
enable {no | yes} |
sw {no | yes}
}
}
Options
> setting
> application
+ bypass-exceed-queue Set whether to skip inspection of session if queue limit is exceeded
+ cache Set if application cache should be enabled. This will enable or disable the App-ID cache for all purposes,
which include: help in identifying some evasive applications, caching App-IDs for application identification, enable
Policy Based Forwarding (PBF) based on application, and to improve performance under certain traffic mix
conditions. As of PAN-OS 5.0.2, you can disable just the App-ID portion of this feature. See the use-cache-foridentification option.
+ cache-threshold Set application cache threshold (between 1 and 65535)
+ dump-unknown Set if unknown application capture should be enabled
+ heuristics Set if heuristics detection should be enabled
+ identify-unknown-traffic-by-port Set if unknown traffic should be identified by source or destination port
+ notify-user Set if user should be notified when web-application is blocked
+ supernode Set if supernode detection should be enabled
+ use-cache-for-identification As of PAN-OS 5.0.2, the App-ID cache will not be used for security policies purposes
by default. This command (added in 5.0.2), will allow you to enable the App-ID cache. For more information on this
feature, refer to the security advisory PAN-SA-2013-001.
> traceroute enable or disable application identification for traceroute, specify TTL threshold value for traceroute
identification
> config rematch (no or yes)
> ctd
+ tcp-bypass-exceed-queue Set whether to skip inspection of TCP session if queue limit is exceeded
+ udp-bypass-exceed-queue Set whether to skip inspection of UDP session if queue limit is exceeded
+ cap-portal-ask-timeout Set captive portal timeout (seconds)
+ cap-portal-max-session Set maximum number of captive portal sessions
+ extended-capture-segment Set number of segments of threat packet capture (1-50, default 5)
+ http-proxy-use-transaction Set whether to use transaction for stats for http proxy sessions
+ skip-block-http-range Whether to skip the blocking of HTTP range requests
+ strip-x-fwd-for Set whether to strip x-forwarded-for in http header. When this option is selected, the firewall zeroes
out the header value before forwarding the request, and the forwarded packets do not contain internal source IP
information.
+ url-admin-timeout Set URL admin continue timeout in minutes (1-86400)
+ url-coach-timeout Set URL coach continue timeout in minutes (1-86400)
+ url-lockout-timeout Set URL admin override lockout timeout in minutes (1-86400)
+ url-wait-timeout Set URL category query timeout in seconds (1-60)
+ x-forwarded-for Enable/disable parsing of x-forwarded-for attribute
> custom-logo
+ hide-panorama-header-background (Panorama only) Whether to hide Panorama header background
> login-screen Import custom logo for login screen (from content or file)
+ content Upload custom login screen page (base64 encoded)
+ name File name alphanumeric string [ 0-9a-zA-Z./_-]
> main-ui Import custom logo for main user interface (from content or file)
+ content Upload custom main user interface page (base64 encoded)
+ name File name alphanumeric string [ 0-9a-zA-Z./_-]
> pdf-report-footer Import custom logo for PDF report footers (from content or file)
+ timeout-tcp-half-closed Sets TCP half-closed session timeout (after receiving first FIN) value in seconds (1-604800,
default 120)
+ timeout-tcp-time-wait Sets TCP time wait timeout (after receiving second FIN or a RST) value in seconds (1-600,
default 15)
+ timeout-tcp-unverified-rst Sets TCP unverified RST timeout (after receiving a RST with unverified sequence
number) value in seconds (1-600, default 30)
+ timeout-tcphandshake Sets the TCP handshake session timeout value (before 3-way handshaking is completed), in
seconds (1-60)
+ timeout-tcpinit Sets TCP initial session timeout (before 3-way handshaking is completed) value in seconds (1-60)
+ timeout-udp Sets UDP timeout value in seconds (1-604800)
> ssl-decrypt
+ answer-timeout Sets user reply timeout value in seconds (1-86400)
+ block-timeout-cert Sets whether to block a session if certificate status can't be retrieved within timeout
+ block-unknown-cert Sets whether to block a session if certificate status is unknown
+ cert-status-timeout Sets cert status query timeout value in seconds (0-60)
+ crl Sets whether to use CRL to check certificate status
+ crl-receive-timeout Sets CRL receive timeout value in seconds (1-60)
+ fwd-proxy-server-cert-key-size Sets the key size used in SSL/TLS Forward Proxy certificates that PAN-OS
generates for the connection between the firewall and the client. The value options are:
0 PAN-OS determines the key size to use based on the key size that the destination server uses. If the destination
server uses a 1024-bit RSA key, PAN-OS generates a certificate with that key size and an SHA-1 hashing
algorithm. If the destination server uses a key size that exceeds 1024 bits (for example, 2048 bits or 4096 bits),
PAN-OS generates a certificate that uses a 2048-bit RSA key and SHA-256 algorithm. This is the default
setting.
1024 PAN-OS generates certificates that use a 1024-bit RSA key and SHA-1 hashing algorithm regardless of the
key size that the destination server uses. As of December 31, 2013, public certificate authorities (CAs) and
popular browsers have limited support for X.509 certificates that use keys of fewer than 2048 bits. In the future,
depending on security settings, when presented with such keys the browser might warn the user or block the
SSL/TLS session entirely.
2048 PAN-OS generates certificates that use a 2048-bit RSA key and SHA-256 hashing algorithm regardless of
the key size that the destination server uses. Public CAs and popular browsers support 2048-bit keys, which
provide better security than the 1024-bit keys.
+ notify-user Sets if user notification should be enabled
+ ocsp Sets whether to use OCSP to check certificate status
+ ocsp-receive-timeout Sets OCSP receive timeout value in seconds (1-60)
+ url-proxy Sets proxy for SSL sessions if the IPs URL category is blocked
> tcp
+ asymmetric-path Actions for TCP sliding window tracking errors, also controls enable/disable TCP sequence
number check for FIN/RST
bypass Bypass inspection for the session that has TCP sliding window tracking errors
drop Drop offending packets that violated TCP sliding window tracking, enable TCP sequence number check for
FIN/RST
+ bypass-exceed-oo-queue Whether to skip inspection of session if out-of-order packets limit is exceeded
+ check-timestamp-option Whether to drop packets with invalid timestamp options
+ urgent-data Clears urgent flag in TCP header
clear Always clear urgent data pointers (default)
oobinline Assume host process OOB data inline with normal data
> url
+ dynamic-url (for BrightCloud only) Enable this option if you are using URL categories as part of your match criteria
for security policies and would like to enable dynamic lookups as part of that process. This is a global setting that
will allow the URL lookup during a policy match to query the cloud server if a URL profile is not configured in the
policy.
+ dynamic-url-timeout (for BrightCloud only) Dynamic URL entry timeout, in hours (1-720)
> util
Sample Output
The following command locks an administrative user out for 15 minutes after 5 failed login attempts.
username@hostname# set deviceconfig setting management admin-lockout 5 lockout-time 15
Syntax
set deviceconfig
{
system
{
authentication-profile <value> |
certificate-profile <value> |
common-name-for-certificate <value> |
default-gateway <ip_address> |
deployment-update-schedule <name> <type> recurring <hourly/daily/weekly> [<dayof-week>] at <time> action <action> <list of device serial numbers>
domain <value> |
domain-lookup-url <value> |
fqdn-forcerefresh-time <value> |
fqdn-refresh-time <value> |
hostname <value> |
ip-address <ip_address> |
ip-address-lookup-url <value> |
ipv6-address <ip/netmask> |
ipv6-default-gateway <value> |
locale {en_US | ja_JP | zh_CN | zh_TW} |
login-banner <value> |
mtu <value> |
netmask <value> |
ntp-server-1 <value> |
ntp-server-2 <value> |
panorama-server <value> |
panorama-server-2 <value> |
secure-proxy-password <value> |
secure-proxy-port <value> |
secure-proxy-server <value> |
secure-proxy-user <value> |
server-verification {no | yes} |
speed-duplex <value> |
syslog-certificate <value> |
timezone <value> |
update-server <value> |
web-server-certificate <value> |
config-bundle-export-schedule |
{
description <value> |
enable {no | yes} |
start-time <value> |
protocol
{
ftp {hostname <value> | passive-mode {no | yes} | password <value> | path
<value> | port <value> | username <value>} |
at <value> |
day-of-week {friday | monday | saturday | sunday | thursday | tuesday |
wednesday} |
action {download-and-install | download-only}
}
}
app-profile recurring |
{
sync-to-peer {no | yes} |
threshold <value> |
daily at <value> action {download-and-install | download-only} |
hourly at <value> action {download-and-install | download-only} |
weekly
{
at <value> |
day-of-week {friday | monday | saturday | sunday | thursday | tuesday |
wednesday} |
action {download-and-install | download-only}
}
}
global-protect-datafile recurring |
{
daily at <value> action download-and-install |
hourly at <value> action download-and-install |
weekly
{
at <value> |
day-of-week {friday | monday | saturday | sunday | thursday | tuesday |
wednesday} |
action download-and-install
}
}
statistics-service |
{
application-and-threat-reports |
{
application-usage {no | yes} |
attackers {no | yes} |
attacking-countries {no | yes}
}
device software-crash-info {no | yes} |
unknown-application-reports |
{
unknown-applications-by-destination-addresses {no | yes} |
unknown-applications-by-destination-ports {no | yes}
}
url-reports
{
dataplane-cache-url {no | yes} |
malware-categories-by-url {no | yes} |
unknown-categories-by-url {no | yes}
}
}
threats recurring |
{
sync-to-peer {no | yes} |
threshold <value> |
daily at <value> action {download-and-install | download-only} |
hourly at <value> action {download-and-install | download-only} |
weekly
{
at <value> |
day-of-week {friday | monday | saturday | sunday | thursday | tuesday |
wednesday} |
action {download-and-install | download-only}
}
}
url-database recurring
{
daily at <value> action download-and-install |
weekly
{
at <value> |
day-of-week {friday | monday | saturday | sunday | thursday | tuesday |
wednesday} |
action download-and-install
{
{
wf-private recurring |
{
sync-to-peer {no | yes} |
every-15-mins {
action {download-and-install | download-only} at <value>;
}
every-30-mins {
action {download-and-install | download-only} at <value>;
{
every-5-mins {
action {download-and-install | download-only} at <value>;
}
every-mins {
action {download-and-install | download-only} at <value>;
{
{
{
}
wildfire recurring |
{
sync-to-peer {no | yes} |
every-15-mins {
action {download-and-install | download-only} at <value>;
}
every-30-mins {
action {download-and-install | download-only} at <value>;
{
every-hour {
action {download-and-install | download-only} at <value>;
}
every-mins {
action {download-and-install | download-only} at <value>;
{
{
}
}
}
}
Options
> system
+ authentication-profile Authentication profile to use for non-local administrators (RADIUS method is supported)
+ certificate-profile Profile for verifying client certificates
+ common-name-for-certificate Common name recognized by devices, if different from IP address
+ default-gateway Default gateway IP address
+ domain Domain value
+ domain-lookup-url Domain lookup URL
+ fqdn-forcerefresh-time Seconds for Periodic Timer to force refresh FQDN object entries (14400-86400)
+ fqdn-refresh-time Seconds for Periodic Timer to refresh expired FQDN object entries (600-14399)
+ hostname Hostname value
+ ip-address IP address for the management interface
+ ip-address-lookup-url IP address lookup URL
+ ipv6-address IPv6/netmask for the management interface
+ ipv6-default-gateway IPv6 for the default gateway
+ locale System default locale (US, Japan, CN, or TW)
+ login-banner Login banner text
+ mtu Maximum Transmission Unit (MTU) for the management interface
+ netmask IP address or IPv6 for the management interface network mask
+ ntp-server-1 First Network Time Protocol (NTP) server IP address
+ ntp-server-2 Second Network Time Protocol server IP address
+ panorama-server First Panorama server IP address or FQDN
+ panorama-server-2 Second Panorama server IP address or FQDN
+ secure-proxy-password Secure Proxy password to use
+ secure-proxy-port Port for secure proxy server (1-65535)
+ secure-proxy-server Secure Proxy server to use
+ secure-proxy-user Secure Proxy user name to use
+ server-verification Verify update server identity (yes or no)
+ speed-duplex Speed and duplex for the management interface (100Mbps-full-duplex, 100Mbps-half-duplex, 10Mbpsfull-duplex, 10Mbps-half-duplex, 1Gbps-full-duplex, 1Gbps-half-duplex, or auto-negotiate)
+ timezone Time zone name (press <tab> for a list of time zones)
+ update-server Palo Alto Networks update server
+ web-server-certificate Certificate for secure web GUI
> config-bundle-export-schedule (Panorama only) Schedule for exporting configuration bundles
+ description Description text
+ enable Enable export
+ start-time Time to start the scheduled export hh:mm (e.g., 03:30)
> protocol Protocol to use for export
> ftp Use FTP protocol for export
+ hostname FTP hostname
+ passive-mode Enable FTP Passive Mode
+ password FTP password
+ path FTP server path
+ port FTP port (1-65535)
set display-name
set display-name
Configures a system name that will be used as an identifier in other commands.
Syntax
set display-name <name>
Options
<name> Specifies the display name for the system
set email-scheduler
set email-scheduler
Specifies settings for email delivery of PDF summary reports.
Syntax
set email-scheduler <name>
{
email-profile <value> |
recipient-emails <value> |
report-group <value> |
recurring
{
weekly {friday | monday | saturday | sunday | thursday | tuesday | wednesday} |
daily |
disabled
}
}
Options
<name> Specifies the name for the email scheduler
+ email-profile Email profile value
+ recipient-emails Recipient emails value
+ report-group Report group value
> recurring Recurring frequency
> weekly Once a week; specify the day
- daily Every day
- disabled No scheduling
set external-list
set external-list
Specifies settings for external lists of blocked sites. Managed devices can import the list on a scheduled basis. The
source of a list can be a file server or web server. After specifying a dynamic block list object, you can then use it as
a source or destination for security policies.
Syntax
set external-list <name>
{
description <value> |
type ip |
url <value> |
recurring
{
daily at <value> |
hourly at <value> |
monthly {at <value> | day-of-month <value>} |
weekly {at <value> | day-of-week <value>}
}
}
Options
<name> Specifies the name for the external list
+ description Description of the object
+ type Specifies type of list (IP addresses)
+ url URL or server path to the list
> recurring Schedule for importing the list
> daily Recurring every day, time specification hh:mm (e.g. 20:10)
> hourly Recurring every hour, time specification mm (e.g. 10)
> monthly Recurring monthly
+ at Time specification hh:mm (e.g. 20:10)
+ day-of-month Day of the month (1-31)
> weekly Recurring once a week
+ at Time specification hh:mm (e.g. 20:10)
+ day-of-month Day of the week (Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday)
set global-protect
set global-protect
Configures GlobalProtect on the firewall. GlobalProtect provides security for client systems, such as laptops, that are
used in the field by allowing easy and secure login from anywhere in the world.
For more information, refer to the GlobalProtect Administrators Guide.
Syntax
set global-protect
{
global-protect-gateway <name> |
{
authentication-profile <value> |
certificate-profile <value> |
remote-user-tunnel <value> |
satellite-tunnel <value> |
server-certificate <value> |
tunnel-mode {no | yes} |
hip-notification <name> {match-message <value> | not-match-message <value>} |
local-address |
{
interface <value> |
floating-ip <ip_address> |
ip <ip_address>
}
roles default
{
inactivity-logout {days | hours | minutes} |
login-lifetime {days | hours | minutes}
}
}
global-protect-mdm <name> |
{
client-certificate <value> |
disabled {no | yes} |
host <value> |
port <value> |
root-ca <value> |
}
global-protect-portal <name> |
{
client-config |
{
agent-user-override-key <value> |
client-certificate <value> |
configs <value>
{
client-certificate {my-fwd-trust | my-fwd-untrust} |
connect-method {on-demand | pre-logon | user-logon} |
mdm-address <value> |
mdm-enrollment-port <value> |
set global-protect
set global-protect
Options
> global-protect-gateway GlobalProtect gateway configuration
+ authentication-profile Authentication profile used for this GlobalProtect gateway
set global-protect
set global-protect
set global-protect
set group-mapping
set group-mapping
Configures group mapping and Lightweight Directory Access Protocol (LDAP) settings for use in authentication
profiles.
Syntax
set group-mapping <name>
{
disabled {no | yes} |
group-filter <value> |
server-profile <name> |
update-interval <value> |
user-filter <value> |
container-object <value> |
group-include-list <value> |
group-member <member_value> |
group-name <member_value> |
group-object <member_value> |
last-modify-attr <member_value> |
user-name <member_value> |
user-object <member_value>
}
Options
<name> Specifies the LDAP server group mapping
+ disabled Disabled (no or yes)
+ group-filter LDAP search filter for group
+ server-profile LDAP server object name
+ update-interval Interval for updating group membership, in seconds (60-86400; default = 3600 seconds)
+ user-filter LDAP search filter for user
> container-object Container object class
> group-include-list Specify the list of user groups to include in the policy (value or list of values enclosed in [ ])
> group-member Group member attribute (value or list of values enclosed in [ ])
> group-name Group name attribute (value or list of values enclosed in [ ])
> group-object Group object class (value or list of values enclosed in [ ])
> last-modify-attr Last modify timestamp attribute
> user-name User name attribute (value or list of values enclosed in [ ])
> user-object User object class (value or list of values enclosed in [ ])
set log-collector
set log-collector
(Panorama only) Configures distributed log collecting across devices, managed by Panorama.
For more information, refer to the Panorama Administrators Guide.
Syntax
set log-collector <name>
{
authentication-setting |
{
admin-lockout {failed-attempts <value> | lockout-time <value>} |
users admin {phash <value>}
}
deviceconfig system |
{
default-gateway <ip_address> |
domain <value> |
hostname <value> |
ip-address <ip_address> |
ipv6-address <ip/netmask> |
ipv6-default-gateway <value> |
login-banner <value> |
netmask <value> |
mtu <value> |
ntp-server-1 <value> |
ntp-server-2 <value> |
panorama-server <value> |
panorama-server-2 <value> |
speed-duplex <value> |
syslog certificate <value> |
timezone <value> |
dns-setting servers {primary <value> | secondary <value>} |
eth1 |
{
+ default-gateway <value> |
+ ip-address <value> |
+ ipv6-address <value> |
+ ipv6-default-gateway <value> |
+ mtu <value> |
+ netmask <value> |
+ speed-duplex <value> |
> permitted-ip <value> |
> service
{
disable-icmp {no | yes} |
}
}
eth2 |
{
+ default-gateway <value> |
set log-collector
+
+
+
+
+
+
>
>
ip-address <value> |
ipv6-address <value> |
ipv6-default-gateway <value> |
mtu <value> |
netmask <value> |
speed-duplex <value> |
permitted-ip <value> |
service
{
disable-icmp {no | yes} |
}
}
geo-location |
{
latitude <coordinate> |
longitude <coordinate>
}
logging-functions
{
collector-group-communication {mgt | <value>} |
device-log-collection {mgt | <value>} |
}
permitted-ip <value> |
service
{
disable-icmp {no | yes} |
disable-snmp {no | yes} |
disable-ssh {no | yes} |
}
disk-settings disk-pair <value> |
}
Options
<name> Specifies the log collector device
> authentication-setting Authentication settings
> admin-lockout Administrative login lockout settings
+ failed-attempts Number of failed login attempts to trigger lock-out (0-10)
+ lockout-time Number of minutes to lock-out (0-60)
> users Admin users
+ phash Password hash value
> deviceconfig Device system configurations
+ default-gateway Default gateway IP address
+ domain Domain value
+ hostname Hostname value
+ ip-address IPv4 address for the management interface
+ ipv6-address IPv6/netmask for the management interface
+ ipv6-default-gateway IPv6 for the default gateway
+ login-banner Login banner text
+ netmask IPv4 network mask for the management interface
+ mtu Maximum Transmission Unit (MTU) for the management interface
+ ntp-server-1 First Network Time Protocol (NTP) server IP address
+ ntp-server-2 Second Network Time Protocol server IP address
+ panorama-server First Panorama server IP address or FQDN
set log-collector
set log-collector-group
set log-collector-group
(Panorama only) Defines log collector groups under Panorama management. Collector groups are used to assign
Panorama-managed firewalls to log collectors that will be used to offload the work of log collection that would
normally be handled by the Panorama management server.
For more information, refer to the Panorama Administrators Guide.
Syntax
set log-collector-group {default | <name>}
{
general-setting management |
{
min-retention-period <value> |
disk-quota
{
alarm <value> |
appstat <value> |
config <value> |
dailythsum <value> |
dailytrsum <value>
hipmatch <value> |
hourlythsum <value> |
hourlytrsum <value>
system <value> |
threat <value> |
thsum <value> |
traffic <value> |
trsum <value>
weeklythsum <value> |
weeklytrsum <value>
}
}
log-settings |
{
config |
{
any |
{
send-email |
{
using-email-setting {PAN_Email | <value>} |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP | <value>} |
}
send-syslog |
{
using-syslog-setting {PAN_Syslog | <value>} |
}
set log-collector-group
}
}
email <name> |
hipmatch |
{
any |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
}
}
snmptrap <name> |
syslog <name> |
system |
{
critical |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
}
high |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
<value>} |
| <value>} |
| <value>} |
<value>} |
| <value>} |
| <value>} |
<value>} |
| <value>} |
| <value>} |
set log-collector-group
}
informational |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
}
low |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
}
medium |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
}
}
threat |
{
critical |
{
send-email |
{
using-email-setting {PAN_Email |
<value>} |
| <value>} |
| <value>} |
<value>} |
| <value>} |
| <value>} |
<value>} |
| <value>} |
| <value>} |
<value>} |
set log-collector-group
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
}
high |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
}
informational |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
}
low |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
| <value>} |
| <value>} |
<value>} |
| <value>} |
| <value>} |
<value>} |
| <value>} |
| <value>} |
<value>} |
| <value>} |
| <value>} |
set log-collector-group
}
medium |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
}
}
traffic |
{
any |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
}
}
wildfire |
{
benign |
{
send-email |
{
using-email-setting {PAN_Email |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP
}
send-syslog |
{
using-syslog-setting {PAN_Syslog
}
}
malicious |
{
<value>} |
| <value>} |
| <value>} |
<value>} |
| <value>} |
| <value>} |
<value>} |
| <value>} |
| <value>} |
set log-collector-group
send-email |
{
using-email-setting {PAN_Email | <value>} |
}
send-snmptrap |
{
using-snmptrap-setting {PAN_SNMP | <value>} |
}
send-syslog |
{
using-syslog-setting {PAN_Syslog | <value>} |
}
}
}
}
logfwd-setting |
{
collectors <value> |
devices <value>
}
monitoring-setting
{
snmp-setting |
{
access-setting version |
{
v2c snmp-community-string <value> |
v3
{
users <user_name> |
{
authpwd <value> |
privpwd <value> |
view <value>
}
views <view_name> view <value>
{
mask <value> |
oid <value> |
option {exclude | include}
}
}
snmp-system
{
contact <value> |
location <value> |
}
}
}
}
Options
<name> Specifies the log collector group
set log-collector-group
set log-collector-group
> send-email using-email-setting The server profile name of the email server to which Panorama forwards the threat
logs that firewalls send to the Collector Group.
> send-snmptrap using-snmptrap-setting The server profile name of the SNMP trap server to which Panorama
forwards the threat logs that firewalls send to the Collector Group.
> send-syslog using-syslog-setting The server profile name of the Syslog server to which Panorama forwards the
threat logs that firewalls send to the Collector Group.
> traffic any The external servers to which Panorama forwards the traffic logs that firewalls send to the Collector Group.
> send-email using-email-setting The server profile name of the email server to which Panorama forwards the traffic
logs that firewalls send to the Collector Group.
> send-snmptrap using-snmptrap-setting The server profile name of the SNMP trap server to which Panorama
forwards the traffic logs that firewalls send to the Collector Group.
> send-syslog using-syslog-setting The server profile name of the Syslog server to which Panorama forwards the
traffic logs that firewalls send to the Collector Group.
> wildfire The external servers to which Panorama forwards the WildFire logs that firewalls send to the Collector Group.
You can specify a server for each log type: benign or malicious.
> send-email using-email-setting The server profile name of the email server to which Panorama forwards the
WildFire logs that firewalls send to the Collector Group.
> send-snmptrap using-snmptrap-setting The server profile name of the SNMP trap server to which Panorama
forwards the WildFire logs that firewalls send to the Collector Group.
> send-syslog using-syslog-setting The server profile name of the Syslog server to which Panorama forwards the
WildFire logs that firewalls send to the Collector Group.
> monitoring-setting Monitoring settings
> snmp-setting
> access-setting Access setting version
version v2c
+ snmp-community-string SNMP community string value
version v3
> users User name
+ authpwd Authentication Protocol Password
+ privpwd Privacy Protocol Password
+ view SNMP View Name
> views View name
view OID subtree name
+ mask Subtree mask in hex
+ oid OID of a MIB node
+ option Exclude/include option
> snmp-system
+ contact Email contact information
+ location System location
set mgt-config
set mgt-config
Configures management accounts on the firewall.
Syntax
set mgt-config
{
access-domain <name> {vsys <name>} |
devices <serial_number> |
{
disable-config-backup {no | yes} |
hostname <value> |
ip <value>
}
password-complexity |
{
block-repeated-characters <value> |
block-username-inclusion {no | yes} |
enabled {no | yes} |
minimum-length <value> |
minimum-lowercase-letters <value> |
minimum-numeric-letters <value> |
minimum-special-characters <value> |
minimum-uppercase-letters <value> |
new-password-differs-by-characters <value> |
password-change-on-first-login {no | yes} |
password-change-period-block <value> |
password-history-count <value> |
password-change
{
expiration-period <value> |
expiration-warning-period <value> |
post-expiration-admin-login-count <value> |
post-expiration-grace-period <value>
}
}
password-profile <name> |
{
password-change
{
expiration-period <value> |
expiration-warning-period <value> |
post-expiration-admin-login-count <value> |
post-expiration-grace-period <value>
}
}
users <name>
{
authentication-profile <profile_name> |
client-certificate-only {no | yes} |
password-profile <value> |
set mgt-config
public-key <value> |
permissions role-based |
{
deviceadmin <name> |
devicereader <name> |
custom |
{
profile <name> |
vsys <name>
}
superreader yes |
superuser yes |
vsysadmin <name> {vsys <name> | [list of values]} |
vsysreader <name> {vsys <name> | [list of values]}
}
phash <value> |
preferences |
{
disable-dns {no | yes} |
saved-log-query
{
alarm <name> query <query_value> |
config <name> query <query_value> |
data <name> query <query_value> |
system <name> query <query_value> |
threat <name> query <query_value> |
traffic <name> query <query_value> |
url <name> query <query_value>
}
}
password
}
Options
> access-domain Groups used for restricting administrative access
+ vsys Virtual system name or list of values enclosed in [ ]
> devices (Panorama only) Device serial number
+ disable-config-backup Enable config back up for this device
+ hostname Device ost name
+ ip Device IP address
> password-complexity Password complexity settings
+ block-repeated-characters Block repeated characters count (0-15)
+ block-username-inclusion Block inclusion of username and it's reverse
+ enabled Enable minimal password complexity enforcement
+ minimum-length Minimum password length (0-15)
+ minimum-lowercase-letters Minimum lowercase letters in the password (0-15)
+ minimum-numeric-letters Minimum numeric characters in the password (0-15)
+ minimum-special-characters Minimum special characters (non-alphanumeric) in the password (0-15)
+ minimum-uppercase-letters Minimum uppercase letters in the password (0-15)
+ new-password-differs-by-characters New Password must differ by the count chars (0-15)
+ password-change-on-first-login Password must change on first time login
+ password-change-period-block Password change block period, in days (0-365)
+ password-history-count Save password history for password changes, in days (0-150)
set mgt-config
Syntax
set network dhcp interface <interface_value>
{
relay |
{
ip |
{
enabled {no | yes} |
server <ip_address>
}
ipv6 server
{
enabled {no | yes} |
server <ip/netmask> {interface <value>}
}
}
server
{
mode {auto | disabled | enabled} |
probe-ip {no | yes} |
ip-pool {<ip_range> | <ip/netmask> | <value>} |
option |
{
dns-suffix {inherited | <ip_address>} |
gateway <ip_address> |
pop3-server {inherited | <ip/netmask>} |
smtp-server {inherited | <ip/netmask>} |
dns |
{
primary {inherited | <ip/netmask>} |
secondary {inherited | <ip/netmask>}
}
inheritance source <value> |
lease {timeout <value> | unlimited}
nis |
{
primary {inherited | <ip/netmask>} |
secondary {inherited | <ip/netmask>}
}
ntp |
{
primary {inherited | <ip/netmask>} |
secondary {inherited | <ip/netmask>}
}
wins
{
Options
<interface_value> Interface for DHCP configuration
> relay Relay configuration
> ip DHCP IP configuration
+ enabled Enable configuration
+ server Relay server IP address (x.x.x.x or IPv6 or list enclosed in [ ])
> ipv6 DHCP IPv6 configuration
+ enabled Enable configuration
> server Relay server IPv6 address (x.x.x.x or IPv6 or list enclosed in [ ])
+ interface Specify outgoing interface when using an IPv6 multicast address for your DHCPv6 server
> server Server configuration
+ mode Mode (automatic, disable DHCP server, or enable DHCP server)
+ probe-ip Ping the IP when allocating a new IP
> ip-pool IP subnets or ranges (x.x.x.x-y.y.y.y or IPv6-range or x.x.x.x/y or IPv6/netmask or list of values enclosed in [ ])
> option Server configuration options
+ dns-suffix DNS suffix (inherited or specify SMTP server IP address)
+ gateway Default gateway (x.x.x.x or IPv6)
+ pop3-server Post Office Protocol 3 (POP3) server (inherited or specify IP address and network mask)
+ smtp-server Simple Mail Transfer Protocol (SMTP) server (inherited or specify IP address and network mask)
> dns Primary and secondary Domain Name System (DNS) server IP address(es) (inherited or specify IP address and
network mask)
> inheritance Inherit settings from specified interface
+ source Dynamic interface name
> lease Lease, unlimited or timeout in minutes (0-1000000)
> nis Primary and secondary Network Information Service (NIS) server IP address(es) (inherited or specify IP address
and network mask)
> ntp Primary and secondary Network Time Protocol (NTP) server IP address(es) (inherited or specify IP address and
network mask)
> wins Primary and secondary Windows Internet Name Service (WINS) server IP address(es) (inherited or specify IP
address and network mask)
> reserved Reserved IP address or IPv6 address
+ mac Media Access Control (MAC) address (xx:xx:xx:xx:xx:xx)
Syntax
set network dns-proxy <name>
{
enabled {no | yes} |
cache |
{
enabled {no | yes} |
size <value> |
timeout <value> |
}
default |
{
primary {inherited | <ip/netmask>} |
secondary {inherited | <ip/netmask>} |
inheritance source <interface_name>
}
domain-servers <name> |
{
cacheable {no | yes} |
domain-name <value> |
primary <ip_address> |
secondary <ip_address>
}
interface <interface_name> |
static-entries <name> {address <ip_address> | domain <value>} |
tcp-queries |
{
enabled {no | yes} |
max-pending-requests <value>
}
udp-queries retries {attemps <value> | interval <value>}
}
Options
<name> DNS proxy name
+ enabled Enable or disable processing of DNS requests on interface(s) on this object
> cache Specify DNS cache related settings
+ enabled Turn on/off caching for this DNS object
+ size Max number of entries stored in cache (1024-10240)
Syntax
set network ike
{
crypto-profiles |
{
ike-crypto-profiles {default | <name>} |
{
dh-group {group1 | group14 | group2 | group5 | <list>} |
encryption {3des | aes128 | aes192 | aes256 | <list>} |
hash {md5 | sha1 | sha256 | sha384 | sha512 | <list>} |
lifetime {days | hours | minutes | seconds} <value>
}
ipsec-crypto-profiles {default | <name>} |
{
dh-group {group1 | group14 | group2 | group5 | no-pfs} |
ah authentication {md5 | sha1 | sha256 | sha384 | sha512 | <list>} |
esp |
{
authentication {md5 | sha1 | sha256 | sha384 | sha512 | none | <list>} |
encryption {3des | aes128 | aes192 | aes256 | null | <list>} |
}
lifesize {gb | kb | mb | tb} <value> |
lifetime {days | hours | minutes | seconds} <value>
}
}
gateway <name>
{
authentication
certificate {
local-certificate <cert-name-string>;
certificate-profile <profile-name-string>;
strict-validation-revocation <yes|no>;
allow-id-payload-mismatch <yes|no>;
}
pre-shared-key key <value> |
local-address |
{
interface <value> |
floating-ip <ip_address> |
ip <ip_address>
}
local-id |
{
id <value> |
type {fqdn | ipaddr | ufqdn | <value>}
}
peer-address {ip <ip_address> | dynamic} |
peer-id |
{
id <value> |
type {dn | fqdn | ipaddr | keyid | ufqdn} |
matching {exact | wildcard} |
}
protocol ikev1 |
{
exchange-mode {aggressive | auto | main} |
ike-crypto-profile {default | <name>} |
dpd
{
enable {no | yes} |
interval <value> |
retry <value>
}
}
protocol-common
{
passive-mode {no | yes} |
nat-traversal
{
enable {no | yes}
keep-alive-interval {value} |
udp-checksum-enable {no | yes}
fragmentation {enable <yes|no>}
}
}
}
Options
> crypto-profiles IKE/IPsec Security Association (SA) Proposal Configuration
> ike-crypto-profiles IKE SA proposals; specify default or enter a name
+ dh-group Phase-1 Diffie-Hellman (DH) group; select from the following options, or enter a list of values enclosed in
[]
group1 768-bit Modular Exponentiation (MODP) Group
group14 2048-bit MODP Group, NIST rating 112-bit strength
group2 1024-bit MODP Group, NIST rating 80-bit strength
group5 1536-bit MODP Group
+ encryption Encryption algorithm; select from the following options, or enter a list of values enclosed in [ ]
3des National Institute of Standards and Technology (NIST) rating 112-bit strength
aes128 NIST rating 128-bit strength
aes192 NIST rating 192-bit strength
aes256 NIST rating 256-bit strength
+ hash Hashing algorithm; select from the following options, or enter a list of values enclosed in [ ]
md5 Below 80-bit strength
sha1 NIST rating 128-bit strength
sha256 NIST rating 256-bit strength
sha384 NIST rating over 256-bit strength
sha512 NIST rating over 256-bit strength
> lifetime IKE SA lifetime
> local-id Optionally how peer gateway will identify local gateway instead of using IP address
+ id Local ID string
+ type Type; select from list, or specify other value
fqdn FQDN (hostname)
ipaddr IP address
ufqdn User FQDN (email address)
> peer-address Peer gateway address
> ip Peer gateway has static IP address (x.x.x.x or IPv6)
dynamic Peer gateway has dynamic IP address
> peer-id Optionally how local gateway will identify peer gateway instead of using IP address
+ id Local ID string
+ type Type; select from list, or specify other value
fqdn FQDN (hostname)
ipaddr IP address
ufqdn User FQDN (email address)
> protocol IKE Protocol settings
> ikev1 IKEv1 setting
+ exchange-mode Exchange mode
aggressive Use aggressive mode
auto Choose IKE exchange mode automatically
main Use main mode
+ ike-crypto-profile IKE SA crypto profile name (default or enter a name)
> dpd Dead-Peer-Detection settings
+ enable Enable Dead-Peer-Detection
+ interval Sending interval for probing packets, in seconds (2-100)
+ retry Number of retries before disconnection (2-100)
> protocol-common IKE Protocol settings common to IKEv1 and IKEv2 (IKEv2 to be supported in a future release)
+ passive-mode Enable passive mode (responder only)
> fragmentation IKE fragmentation setting
+ enable Enable IKE fragmentation (yes or no)
> nat-traversal NAT-Traversal settings
+ enable Enable NAT-Traversal (yes or no)
Syntax
set network interface
{
aggregate-ethernet <interface_name> |
{
comment <value> |
ha |
{
lacp |
{
enable {no | yes} |
fast-failover {no | yes} |
max-ports <value> |
mode {active | passive} |
system-priority <value> |
transmission-rate {fast | slow} |
}
}
layer2 |
{
lacp |
{
enable {no | yes} |
fast-failover {no | yes} |
max-ports <value> |
mode {active | passive} |
system-priority <value> |
transmission-rate {fast | slow} |
high-availability |
use-same-system-mac |
{
enable {no | yes} |
mac-address <mac-address> |
}
}
netflow-profile <name> |
units <name_value>
{
comment <value> |
tag <value>
}
}
layer3 |
{
adjust-tcp-mss {no | yes} |
interface-management-profile <value> |
lacp |
{
enable {no | yes} |
fast-failover {no | yes} |
max-ports <value> |
mode {active | passive} |
system-priority <value> |
transmission-rate {fast | slow} |
high-availability |
use-same-system-mac |
{
enable {no | yes} |
mac-address <mac-address> |
}
}
mtu <value> |
netflow-profile <name> |
untagged-sub-interface {no | yes} |
arp {<ip address/netmask> | <address object>} {hw-address <mac_address>} |
dhcp-client |
{
create-default-route {no | yes} |
default-route-metric <value> |
enable {no | yes}
}
ip {<ip address/netmask> | <address object>} |
ipv6 |
{
enabled {no | yes} |
interface-id {EUI-64 | <value>} |
address {<ip address/netmask> | <address object>} {anycast | prefix} |
neighbor-discovery
{
dad-attempts <value> |
enable-dad {no | yes} |
ns-interval <seconds> |
reachable-time <seconds> |
neighbor {<ip address/netmask> | <address object>} {hw-address
<mac_address>} |
router-advertisement
{
enable {no | yes} |
enable-consistency-check {no | yes} |
hop-limit {unspecified | <value>} |
lifetime <value> |
link-mtu {unspecified | <value>} |
managed-flag {no | yes} |
max-interval <value> |
min-interval <value> |
other-flag {no | yes} |
reachable-time {unspecified | <value>} |
retransmission-timer {unspecified | <value>}
}
}
}
units <name_value>
{
comment <value> |
tag <value>
}
}
virtual-wire |
{
netflow-profile <name> |
units <name_value>
{
comment <value> |
tag <value> |
ip-classifier {<ip-range> | {<ip address/netmask> | <address object>}}
}
}
decrypt-mirror |
ha
}
ethernet <interface_name> |
{
comment <value> |
lacp |
{
port-priority <value> |
}
link-duplex {auto | <value>} |
link-speed {auto | <value>} |
link-state {auto | down | up} |
aggregate-group <value> |
layer2 |
{
netflow-profile <name> |
units <name_value>
{
comment <value> |
tag <value>
}
}
layer3 |
{
adjust-tcp-mss {no | yes} |
interface-management-profile <value> |
mtu <value> |
netflow-profile <name> |
untagged-sub-interface {no | yes} |
arp {<ip address/netmask> | <address object>} {hw-address <mac_address>} |
dhcp-client |
{
create-default-route {no | yes} |
default-route-metric <value> |
enable {no | yes}
}
ip {<ip address/netmask> | <address object>} |
ipv6 |
{
enabled {no | yes} |
interface-id {EUI-64 | <value>} |
address {<ip address/netmask> | <address object>}
{
enable-on-interface {no | yes} |
advertise |
{
auto-config-flag {no | yes} |
enable {no | yes} |
onlink-flag {no | yes} |
preferred-lifetime {infinity | <value>} |
valid-lifetime {infinity | <value>}
}
anycast |
prefix
}
neighbor-discovery
{
dad-attempts <value> |
enable-dad {no | yes} |
ns-interval <seconds> |
reachable-time <seconds> |
neighbor {<ip address/netmask> | <address object>} {hw-address
<mac_address>}
router-advertisement
{
enable {no | yes} |
enable-consistency-check {no | yes} |
hop-limit {unspecified | <value>} |
lifetime <value> |
link-mtu {unspecified | <value>} |
managed-flag {no | yes} |
max-interval <value> |
min-interval <value> |
other-flag {no | yes} |
reachable-time {unspecified | <value>} |
retransmission-timer {unspecified | <value>}
}
}
}
pppoe |
{
access-concentrator <value> |
authentication {CHAP | PAP | auto} |
create-default-route {no | yes} |
default-route-metric <value> |
enable {no | yes} |
password <value> |
service <value> |
username <value> |
passive enable {no | yes} |
static-address ip {<ip address/netmask> | <address object>}
}
units <name_value>
{
comment <value> |
tag <value>
}
}
log-card
{
default-gateway <ip> |
ip-address <ip> |
ipv6-address <ipv6> |
ipv6-default-gateway <ip> |
netmask <ip> |
}
tap {netflow-profile <name>} |
virtual-wire |
{
netflow-profile <name> |
units <name_value>
{
comment <value> |
tag <value> |
ip-classifer {<ip-range> | {<ip address/netmask> | <address object>}}
}
}
decrypt-mirror
ha
}
loopback |
{
adjust-tcp-mss {no | yes} |
comment <value> |
interface-management-profile <value> |
mtu <value> |
netflow-profile <name> |
ip <ip_address> |
ipv6 |
{
enabled {no | yes} |
interface-id {EUI-64 | <value>} |
address <ip_address>
enable-on-interface {no | yes} |
anycast |
prefix
{
units <name_value>
}
tunnel |
{
comment <value> |
interface-management-profile <value> |
mtu <value> |
netflow-profile <name> |
reachable-time <seconds> |
neighbor {<ip address/netmask> | <address object>} {hw-address
<mac_address>}
router-advertisement
{
enable {no | yes} |
enable-consistency-check {no | yes} |
hop-limit {unspecified | <value>} |
lifetime <value> |
link-mtu {unspecified | <value>} |
managed-flag {no | yes} |
max-interval <value> |
min-interval <value> |
other-flag {no | yes} |
reachable-time {unspecified | <value>} |
retransmission-timer {unspecified | <value>}
}
}
}
units <name_value>
}
}
Options
> aggregate-ethernet Aggregate interface name (ae1-ae8)
+ comment Comment text for identifying the aggregate interface
> ha HA (high availability) interface
> lacp Link Aggregation Control Protocol (LACP) settings. The interface must be of type HA3.
+ enable Enable (yes) or disable (no) Link Aggregation Control Protocol (LACP) for the aggregate group.
LACP is disabled by default.
+ fast-failover Enter yes if, when an interface goes down, you want the firewall to fail over to an operational
interface within one second. If you enter no, failover occurs at the standard IEEE 802.1AX-defined speed (at
least three seconds).
+ max-ports The value you enter specifies the number of interfaces (1-8) that can be active at any given time in an
LACP aggregate group. The value cannot exceed the number of interfaces you assign to the group. If the number
of assigned interfaces exceeds the number of active interfaces, the firewall uses the port priorities of the
interfaces to determine which are in standby mode. You set port priorities when configuring individual interfaces
for the group.
+ mode Select the LACP mode of the firewall: active or passive. In active mode, the firewall actively
queries the LACP status (available or unresponsive) of peer devices. In passive mode (the default), the firewall
passively responds to LACP status queries from peer devices. Between any two LACP peers, it is recommended
that one be active and the other passive. LACP cannot function if both peers are passive.
+ system-priority The number you enter determines whether the firewall or its peer overrides the other with
respect to port priorities (see the max-ports description). Note that the lower the number, the higher the
priority. The range is 1-65535 and the default is 32768.
+ transmission-rate Enter the rate at which the firewall exchanges queries and responses with peer devices: fast
(every second) or slow (every 30 seconds). The default is slow.
> layer2 Layer 2 interface
+ netflow-profile NetFlow server profile name
> lacp Link Aggregation Control Protocol (LACP) settings. The interface must be of type HA3.
+ enable Enable (yes) or disable (no) Link Aggregation Control Protocol (LACP) for the aggregate group.
LACP is disabled by default.
+ fast-failover Enter yes if, when an interface goes down, you want the firewall to fail over to an operational
interface within one second. If you enter no, failover occurs at the standard IEEE 802.1AX-defined speed (at
least three seconds).
+ max-ports The value you enter specifies the number of interfaces (1-8) that can be active at any given time in an
LACP aggregate group. The value cannot exceed the number of interfaces you assign to the group. If the number
of assigned interfaces exceeds the number of active interfaces, the firewall uses the port priorities of the
interfaces to determine which are in standby mode. You set port priorities when configuring individual interfaces
for the group.
+ mode Select the LACP mode of the firewall: active or passive. In active mode, the firewall actively
queries the LACP status (available or unresponsive) of peer devices. In passive mode (the default), the firewall
passively responds to LACP status queries from peer devices. Between any two LACP peers, it is recommended
that one be active and the other passive. LACP cannot function if both peers are passive.
+ system-priority The number you enter determines whether the firewall or its peer overrides the other with
respect to port priorities (see the max-ports description). Note that the lower the number, the higher the
priority. The range is 1-65535 and the default is 32768.
+ transmission-rate Enter the rate at which the firewall exchanges queries and responses with peer devices: fast
(every second) or slow (every 30 seconds). The default is slow.
> high-availability use-same-system-mac Firewalls in a high availability (HA) pair have the same system priority
value. However, in an active/passive deployment, the system ID for each can be the same or different, depending
on whether you assign the same MAC address. When the LACP peers (also in HA mode) are virtualized
(appearing to the network as a single device), using the same system MAC address for the firewalls is a best
practice to minimize latency during failover. When the LACP peers are not virtualized, using the unique MAC
address of each firewall is the best practice to minimize failover latency. If the firewalls are not in active/passive
HA mode, PAN-OS ignores this field. (Firewalls in an active/active deployment require unique MAC addresses
so PAN-OS automatically assigns them.) LACP uses the MAC address to derive a system ID for each LACP
peer. If the firewall pair and peer pair have identical system priority values, LACP uses the system ID values to
determine which overrides the other with respect to port priorities. If both firewalls have the same MAC address,
both will have the same system ID, which will be higher or lower than the system ID of the LACP peers. If the
HA firewalls have unique MAC addresses, it is possible for one to have a higher system ID than the LACP peers
while the other has a lower system ID.
+ enable Specify whether to use (yes or no) the same system MAC address for both firewall HA peers.
+ mac-address If you enabled the use-same-system-mac option, enter the MAC address of both firewall
HA peers. If you enter a MAC address other than the one the firewall generates automatically, you must
ensure it is globally unique.
> units Logical interface configuration (name.x)
+ comment Comment text
+ tag 802.1q VLAN tag (1-4094)
> layer3 Layer 3 interface
+ adjust-tcp-mss Set if TCP MSS value should be reduced based on mtu
+ interface-management-profile Interface management profile
> lacp Link Aggregation Control Protocol (LACP) settings. The interface must be of type HA3.
+ enable Enable (yes) or disable (no) Link Aggregation Control Protocol (LACP) for the aggregate group.
LACP is disabled by default.
+ fast-failover Enter yes if, when an interface goes down, you want the firewall to fail over to an operational
interface within one second. If you enter no, failover occurs at the standard IEEE 802.1AX-defined speed (at
least three seconds).
+ max-ports The value you enter specifies the number of interfaces (1-8) that can be active at any given time in an
LACP aggregate group. The value cannot exceed the number of interfaces you assign to the group. If the number
of assigned interfaces exceeds the number of active interfaces, the firewall uses the port priorities of the
interfaces to determine which are in standby mode. You set port priorities when configuring individual interfaces
for the group.
+ mode Select the LACP mode of the firewall: active or passive. In active mode, the firewall actively
queries the LACP status (available or unresponsive) of peer devices. In passive mode (the default), the firewall
passively responds to LACP status queries from peer devices. Between any two LACP peers, it is recommended
that one be active and the other passive. LACP cannot function if both peers are passive.
+ system-priority The number you enter determines whether the firewall or its peer overrides the other with
respect to port priorities (see the max-ports description). Note that the lower the number, the higher the
priority. The range is 1-65535 and the default is 32768.
+ transmission-rate Enter the rate at which the firewall exchanges queries and responses with peer devices: fast
(every second) or slow (every 30 seconds). The default is slow.
> high-availability use-same-system-mac Firewalls in a high availability (HA) pair have the same system priority
value. However, in an active/passive deployment, the system ID for each can be the same or different, depending
on whether you assign the same MAC address. When the LACP peers (also in HA mode) are virtualized
(appearing to the network as a single device), using the same system MAC address for the firewalls is a best
practice to minimize latency during failover. When the LACP peers are not virtualized, using the unique MAC
address of each firewall is the best practice to minimize failover latency. If the firewalls are not in active/passive
HA mode, PAN-OS ignores this field. (Firewalls in an active/active deployment require unique MAC addresses
so PAN-OS automatically assigns them.) LACP uses the MAC address to derive a system ID for each LACP
peer. If the firewall pair and peer pair have identical system priority values, LACP uses the system ID values to
determine which overrides the other with respect to port priorities. If both firewalls have the same MAC address,
both will have the same system ID, which will be higher or lower than the system ID of the LACP peers. If the
HA firewalls have unique MAC addresses, it is possible for one to have a higher system ID than the LACP peers
while the other has a lower system ID. In the latter case, when failover occurs on the firewalls, port prioritization
switches between the LACP peers and the firewall that becomes active.
+ enable Specify whether to use (yes or no) the same system MAC address for both firewall HA peers.
+ mac-address If you enabled the use-same-system-mac option, enter the MAC address or both firewall
HA peers.
+ mtu Maximum Transfer Unit, up to 9216 in Jumbo-Frame mode, up to 1500 otherwise
+ netflow-profile NetFlow server profile name
+ untagged-sub-interface Enable untagged sub-interface
> arp ARP configuration IP address and network mask (x.x.x.x/y)
+ hw-address MAC address (xx:xx:xx:xx:xx:xx)
> dhcp-client Dynamic Host Configuration Protocol (DHCP) client configuration
+ create-default-route Automatically create default route pointing to server
+ default-route-metric Metric of the default route created (1-65535)
+ enable Enable the DHCP client
> ip Interface IP address and network mask (x.x.x.x/y)
> ipv6 Interface IPv6 configuration
+ enabled Enable IPv6 on the interface
+ interface-id 64-bit Extended Unique Identifier (EUI-64), or user-defined 64-bit identifier (in hex)
> address IPv6 address or IP address and network mask (x.x.x.x/y)
+ enable-on-interface Configure this address on interface
> advertise Configure router advertisement prefix option
+ auto-config-flag Set the Auto Address Configuration Flag (A-bit) of the prefix in Router
Advertisement messages
+ enable Enable advertising this prefix in router advertisements
+ onlink-flag Set the On-Link Flag (L-bit) of the prefix in Router Advertisement messages
+ preferred-lifetime Preferred Lifetime of the prefix advertised in Router Advertisement messages
(infinity, or between 0-4294967294 seconds)
+ valid-lifetime Valid Lifetime of the prefix advertised in Router Advertisement messages (infinity, or
between 0-4294967294 seconds)
anycast Anycast address
prefix Use this as prefix to form full address with interface id/EUI-64 (64-bit extended unique identifier)
> neighbor-discovery Neighbor Discovery configuration
+ dad-attempts Number of consecutive neighbor solicitation messages sent for duplicate address detection (010)
+ enable-dad Enable duplicate address detection
+ ns-interval Interval (in seconds) between consecutive neighbor solicitation messages (1-3600)
+ reachable-time Time (in seconds) that the Reachable status for a neighbor can be maintained (10-3600)
> neighbor Static entries in neighbor cache IP address and network mask (x.x.x.x/y)
+ hw-address MAC address (xx:xx:xx:xx:xx:xx)
> router-advertisement Router advertisement configuration
+ enable Enable router advertisement
+ enable-consistency-check Check consistency of RA messages from other routers
+ hop-limit Current Hop Limit advertised in Router Advertisement messages (unspecified, or between
1-255)
+ lifetime Router Lifetime advertised in Router Advertisement messages, in seconds (0-9000)
+ link-mtu Value of MTU option in Router Advertisement messages (unspecified, or between 12809216)
+ managed-flag Set the Managed Configuration Flag (M-bit) in Router Advertisement messages
+ max-interval Maximum interval between consecutive unsolicited Router Advertisement messages, in
seconds (4-1800)
+ min-interval Minimum interval between consecutive unsolicited Router Advertisement messages, in
seconds (3-1350)
+ other-flag Set the Other Stateful Configuration Flag (O-bit) in Router Advertisement messages
+ reachable-time Reachable Time (in milliseconds) advertised in Router Advertisement messages
(unspecified, or between 0-3600000)
+ retransmission-timer Retransmission Timer (in milliseconds) advertised in Router Advertisement
messages (unspecified, or between 0-4294967295)
> units Logical interface (name.x)
+ comment Comment text
+ tag 802.1q VLAN tag (1-4094)
> virtual-wire Virtual-wire interface
+ netflow-profile NetFlow server profile name
> units Logical interface (name.x)
+ comment Comment text
+ tag 802.1q VLAN tag (1-4094)
> ip-classifier Internet Protocol classifier, either IP range (ip1-ip2), IP/network mask, or list of values between [ ]
ha Interface for high-availability functions
> ethernet Ethernet interface alphanumeric string [ 0-9a-zA-Z./_-] (format: ethernetx/x)
+ comment Comment text for identifying the interface
> lacp port-priority The firewall only uses this field if you enabled Link Aggregation Control Protocol (LACP) for the
aggregate group (see aggregate-ethernet). An aggregate group might have more interfaces than it supports in
active states. (In the aggregate group configuration, the Max Ports parameter determines the number of active interfaces).
In this case, the port priority assigned to each interface determines whether it is active or standby. The lower the numeric
value, the higher the priority. The range is 1-65535 and the default is 32768.
+ link-duplex Interface link duplex setting or auto-detect
+ link-speed Interface link speed or auto-detect
+ link-state Interface link state (auto-detect, force to down, or force to up)
> aggregate-group Aggregate interface group name
> layer2 Layer 2 interface
+ netflow-profile NetFlow server profile name
> units Logical interface configuration (name.x)
+ comment Comment text
+ tag 802.1q VLAN tag (1-4094)
> layer3 Layer 3 interface
+ adjust-tcp-mss Set if TCP MSS value should be reduced based on mtu
+ interface-management-profile Interface management profile
+ mtu Maximum Transfer Unit, up to 9216 in Jumbo-Frame mode, up to 1500 otherwise
+ netflow-profile NetFlow server profile name
+ untagged-sub-interface Enable untagged sub-interface
> arp ARP configuration IP address and network mask (x.x.x.x/y)
+ hw-address MAC address (xx:xx:xx:xx:xx:xx)
Sample Output
The following command assigns the ethernet1/4 interface to be a virtual wire interface.
[edit]
username@hostname# set network interface ethernet ethernet1/1 virtual-wire
[edit]
username@hostname#
The following command sets the VLAN IP address to 1.1.1.4/32 from the network interface vlan level of the
hierarchy.
[edit network interface vlan]
username@hostname# set ip 1.1.1.4/32
[edit network interface vlan]
username@hostname#
Syntax
set network profiles
{
interface-management-profile <name>
{
http {no | yes} |
http-ocsp {no | yes} |
https {no | yes} |
ping {no | yes} |
response-pages {no | yes} |
snmp {no | yes} |
ssh {no | yes} |
telnet {no | yes} |
userid-service {no | yes} |
userid-syslog-listener-ssl {no | yes}
userid-syslog-listener-udp {no | yes}
permitted-ip {<ip address/netmask> | <address object>}
}
monitor-profile {default | <name>} |
{
action {fail-over | wait-recover} |
interval <value> |
threshold <value>
}
zone-protection-profile <name>
{
asymmetric-path {bypass | drop | global} |
description <value> |
discard-icmp-error {no | yes} |
discard-icmp-frag {no | yes} |
discard-icmp-large-packet {no | yes} |
discard-icmp-ping-zero-id {no | yes} |
discard-ip-frag {no | yes} |
discard-ip-spoof {no | yes} |
discard-loose-source-routing {no | yes} |
discard-malformed-option {no | yes} |
discard-overlapping-tcp-segment-mismatch {no | yes} |
discard-record-route {no | yes} |
discard-security {no | yes} |
discard-stream-id {no | yes} |
discard-strict-source-routing {no | yes} |
discard-timestamp {no | yes} |
discard-unknown-option {no | yes} |
remove-tcp-timestamp {no | yes} |
suppress-icmp-needfrag {no | yes} |
suppress-icmp-timeexceeded {no | yes} |
tcp-reject-non-syn {global | no
flood |
{
icmp |
{
enable {no | yes} |
red
{
activate-rate <value>
alarm-rate <value> |
maximal-rate <value>
}
}
icmpv6 |
{
enable {no | yes} |
red
{
activate-rate <value>
alarm-rate <value> |
maximal-rate <value>
}
}
other-ip |
{
enable {no | yes} |
red
{
activate-rate <value>
alarm-rate <value> |
maximal-rate <value>
}
}
tcp-syn |
{
enable {no | yes} |
red
{
activate-rate <value>
alarm-rate <value> |
maximal-rate <value>
}
syn-cookies
{
activate-rate <value>
alarm-rate <value> |
maximal-rate <value>
}
}
udp
{
enable {no | yes} |
red
{
| yes} |
activate-rate <value> |
alarm-rate <value> |
maximal-rate <value>
}
}
}
ipv6 |
{
anycast-source {no | yes} |
icmpv6-too-big-small-mtu-discard {no | yes} |
ipv4-compatible-address {no | yes} |
multicast-source {no | yes} |
needless-fragment-hdr {no | yes} |
options-invalid-ipv6-discard {no | yes} |
reserved-field-set-discard {no | yes} |
routing-header {no | yes} |
filter-ext-hdr |
{
dest-option-hdr {no | yes} |
hop-by-hop-hdr {no | yes} |
routing-hdr {no | yes} |
}
ignore-inv-pkt
{
dest-unreach {no | yes} |
param-problem {no | yes} |
pkt-too-big {no | yes} |
redirect {no | yes} |
time-exceeded {no | yes}
}
}
scan <threat_id>
{
interval <value> |
threshold <value> |
action
{
block-ip |
{
duration <value> |
track-by {source | source-and-desintation}
}
alert |
allow |
block
}
}
}
}
Options
> interface-management-profile Interface management profile configuration
+ http Enable HTTP service on the interface
+ http-ocsp Enable HTTP Online Certificate Status Protocol (OCSP) service on the interface
+ https Enable HTTPS service on the interface
+ ping Enable Ping service on the interface
+ response-pages Enable response pages on the interface
+ snmp Enable SNMP service on the interface
+ ssh Enable SSH service on the interface
+ telnet Enable Telnet service on the interface
+ userid-service Enable user ID service on the interface
+ userid-syslog-listener-ssl Enable user ID syslog listener service (no or yes)
+ userid-syslog-listener-udp Enable user ID UDP listener service (no or yes)
> permitted-ip Permitted IP address and network mask (x.x.x.x/y or IPv6/netmask)
> monitor-profile Monitor profile configuration
+ action Configure action triggered when tunnel status change
fail-over When tunnel is down, make traffic fail over to backup path is configured
wait-recover When tunnel is down, wait for the recover
+ interval Probing interval in seconds (2-100)
+ threshold Number of failed probe to determine tunnel is down (2-10)
> zone-protection-profile Zone-based protection profile configuration
+ asymmetric-path Actions for TCP sliding window tracking errors, also control enable/disable TCP sequence number
check for FIN/RST
bypass Bypass inspection for the session that has TCP sliding window tracking errors
drop Drop offending packets that violated TCP sliding window tracking, enable TCP sequence number check for FIN/
RST
global Use global setting
+ description Description value
+ discard-icmp-error Discard ICMP embedded with error message
+ discard-icmp-frag Discard ICMP fragment
+ discard-icmp-large-packet Discard Large ICMP packet (IP length > 1024B)
+ discard-icmp-ping-zero-id Discard ICMP Ping with zero ID
+ discard-ip-frag Discard IP fragment
+ discard-ip-spoof Discard spoofed IP packet
+ discard-loose-source-routing Discard packets with loose source routing IP option
+ discard-malformed-option Discard packets with malformed IP option
+ discard-overlapping-tcp-segment-mismatch Discard sessions with mismatched TCP overlapping segment
+ discard-record-route Discard packets with Record Route IP option
+ discard-security Discard packets with Security IP option
+ discard-stream-id Discard packets with Stream ID IP option
+ discard-strict-source-routing Discard packets with strict source routing IP option
+ discard-timestamp Discard packets with Timestamp IP option
+ discard-unknown-option Discard packets with unknown IP option
+ remove-tcp-timestampStrip the TCP timestamp from the TCP header, if present.
+ suppress-icmp-needfrag Do not reply ICMP NEEDFRAG (layer3 only)
+ suppress-icmp-timeexceeded Do not reply ICMP TTL expired error (layer3 only)
+ tcp-reject-non-syn Reject non-SYN TCP packet for session setup
global Use global setting
no Accept non-SYN TCP. Note that allowing non-SYN TCP traffic may prevent file blocking policies from working
as expected in cases where the client and/or server connection is not set after the block occurs.
yes Reject non-SYN TCP
> flood Flood protection
> icmp ICMP flood protection
+ enable Enable ICMP flood protection
> red Random Early Drop (RED)
+ activate-rate Packet rate (pps) to start RED (1-2000000)
+ alarm-rate Packet rate (pps) to generate alarm (0-2000000)
Syntax
set network qos
{
interface <interface_name>
{
enabled {no | yes} |
interface-bandwidth {egress-max <value>} |
regular-traffic |
{
bandwidth {egress-guaranteed <value> | egress-max <value>} |
default-group {qos-profile {default | <value>}} |
groups regular-traffic-group {members <name>}
{
qos-profile {default | <value>} |
match
{
local-address
{
address {any | {<ip address/netmask> | <address object>}} |
interface <value>
}
}
}
}
tunnel-traffic
{
bandwidth {egress-guaranteed <value> | egress-max <value>} |
default-group {per-tunnel-qos-profile {default | <value>}} |
groups tunnel-traffic-group {members <tunnel_interface> {qos-profile {default
| <value>}}}
}
}
profile {default | <name>}
{
aggregate-bandwidth {egress-guaranteed <value> | egress-max <value>} |
class <traffic_class_value>
{
priority {high | low | medium | real-time} |
class-bandwidth {egress-guaranteed <value> | egress-max <value>}
}
}
}
Options
> interface Interface QoS configuration (select from the list or enter a new name)
> interface-bandwidth Interface bandwidth in mega-bits per second
+ egress-max Maximum sending bandwidth in mbps (0-16000)
> regular-traffic QoS setting for regular traffic
> bandwidth Bandwidth of all regular traffic in mega-bit per second
+ egress-guaranteed Guaranteed sending bandwidth in mbps (0-16000)
+ egress-max Maximum sending bandwidth in mbps (0-16000)
> default-group QoS setting for regular traffic without specified QoS settings
+ qos-profile Apply default or specify QoS profile for aggregated traffic
> groups QoS setting for regular traffic
> members Specify QoS setting for traffic go through given group of hosts
+ qos-profile Apply default or specify QoS profile for traffic go through the group of hosts
> match Specify matching criteria for the QoS entity
> local-address Matching address on local side
+ address Any or x.x.x.x/y or IPv6/netmask or a list of values enclosed in [ ]
+ interface Local-side interface
> tunnel-traffic QoS setting for tunneled traffic
> bandwidth Bandwidth of all tunnel traffic in mega-bits per second
+ egress-guaranteed Guaranteed sending bandwidth in mbps (0-16000)
+ egress-max Maximum sending bandwidth in mbps (0-16000)
> default-group QoS setting for tunneled traffic without specified QoS settings
+ per-tunnel-qos-profile Apply default or specify QoS profile for traffic go through each tunnel interface
> groups QoS setting for tunneled traffic
> members Specify QoS setting for traffic go through given tunnel interface
+ qos-profile Apply default or specify QoS profile for traffic go through the tunnel interface
> profile QoS profile; default or specify a name
> aggregate-bandwidth Aggregate bandwidth of all classes in mega-bits per second
+ egress-guaranteed Guaranteed sending bandwidth in mbps (0-16000)
+ egress-max Maximum sending bandwidth in mbps (0-16000)
> class QoS setting for traffic classes
+ priority Traffic class priority (high, low, medium, or real-time = highest priority)
> class-bandwidth Class bandwidth in mega-bits per second
+ egress-guaranteed Guaranteed sending bandwidth in mbps (0-16000)
+ egress-max Maximum sending bandwidth in mbps (0-16000)
Syntax
set network shared-gateway <name>
{
display-name <name> |
address <name> {description <value> | fqdn <value> | ip-netmask {<ip address/
netmask> | ip-range <ip_range>} | tag <value>}
address-group {
{
description <value> |
dynamic {filter <value>} |
static <value> |
tag <value>
}
import
{
dns-proxy <value> |
network interface <value>
}
log-settings |
{
email <name> |
{
format
{
config <value> |
hip-match <value> |
system <value> |
threat <value> |
traffic <value> |
escaping {escape-character <value> | escaped-characters <value>}
}
server <name>
{
and-also-to <value> |
display-name <name> |
from <value> |
gateway <value> |
to <value>
}
}
profiles <name> |
{
alarm {critical | high | informational | low | medium} |
{
send-to-panorama {no | yes} |
send-email using-email-setting <value> |
send-snmptrap using-snmptrap-setting <value> |
send-syslog using-syslog-setting <value>
}
traffic any
{
send-to-panorama {no | yes} |
send-email using-email-setting <value> |
send-snmptrap using-snmptrap-setting <value> |
send-syslog using-syslog-setting <value>
}
}
snmptrap <name>
{
version v2c server <name>|
{
community <value> |
manager <value>
}
version v3 server <name>
{
authpwd <value> |
engineid <value> |
manager <value> |
privpwd <value> |
user <value> |
}
}
syslog <name> |
{
format |
{
config <value> |
hip-match <value> |
system <value> |
threat <value> |
traffic <value> |
escaping {escape-character <value> | escaped-characters <value>}
}
server <name>
{
facility {LOG_LOCAL0 | LOG_LOCAL1 | LOG_LOCAL2 | LOG_LOCAL3 | LOG_LOCAL4 |
LOG_LOCAL5 | LOG_LOCAL6 | LOG_LOCAL7 | LOG_USER} |
port <value> |
server <value>
}
}
}
rulebase |
{
dos rules <name>
{
description <value> |
disabled {no | yes} |
negate-destination {no | yes} |
negate-source {no | yes} |
schedule <value> |
action {allow | deny | protect} |
destination {any | <value>} |
from {interface <value> | zone <value>} |
protection |
{
aggregate {profile <value>} |
classified
{
profile <value> |
classification-criteria
{
address destination-ip-only |
address source-ip-only |
address src-dest-ip-both
}
}
}
service {any | application-default | service-http | service-https | <value>} |
source {any | <value>} |
source-user {any | known-user | unknown | <value>} |
tag <value> |
to {interface <value> | zone <value>}
}
nat rules <name> |
{
active-active-device-binding {0 | 1 | both | primary} |
description <value> |
disabled {no | yes} |
nat-type {ipv4 | nat64} |
service {any | service-http | service-https | <value>} |
to-interface <value> |
destination {any | <value>} |
destination-translation |
{
translated-address <value> |
translated-port <value>
}
from {any | <value>} |
source {any | <value>} |
source-translation
{
dynamic-ip translated-address <value> |
dynamic-ip-and-port |
{
translated-address <value> |
interface-address
{
interface <interface_name> |
floating-ip <ip_address> |
ip <ip_address>
}
}
static-ip
{
bi-directional {no | yes} |
translated-address <value>
}
}
tag <value> |
to {any | <value>} |
}
pbf rules <name> |
{
active-active-device-binding {0 | 1 | both} |
description <value> |
disabled {no | yes} |
negate-destination {no | yes} |
negate-source {no | yes} |
schedule <value> |
action |
{
forward |
{
egress-interface <value> |
monitor |
{
disable-if-unreachable {no | yes} |
ip-addresss <ip_address> |
profile {default | <value>}
}
nexthop <ip_address>
}
discard |
no-pbf
}
application <value> |
destination {any | <value>} |
enforce-symmetric-return |
{
enabled {no | yes} |
nexthop-address-list <ip_address>
}
from {interface <value> | zone <value>}
service {any | application-default | service-http | service-https | <value>} |
source {any | <value>} |
source-user {any | known-user | unknown | <value>} |
tag <value> |
}
}
service <name> |
{
description <value> |
protocol {tcp | udp} {port <value> | source-port <value>}
}
service-group <name> {service-http | service-https | <value>} |
tag <value>
{
color <value>
comments <value>
zone <name>
{
network
{
log-setting <value> |
zone-protection-profile <value>
external <value> |
layer3 <value> |
}
user-acl
{
+ exclude-list <value> |
+ include-list <value>
}
}
}
Options
<name> Shared gateway name
+ display-name Display name for shared gateway (alphanumeric string [ 0-9a-zA-Z._-])
> address Address configuration
+ description Description that identifies the address
> fqdn Fully Qualified Domain Name (FQDN)
> ip-netmask IP address and network mask (x.x.x.x/y or IPv6/netmask)
> ip-range IP address range (x.x.x.x-y.y.y.y or IPv6-range)
> tag Tag value
> address-group Address-group name and members
+ description Description that identifies the address
> dynamic Dynamic group (specify filter value)
> static Static group (member value or list of values enclosed in [ ])
> tag Tag value
> import Import predefined configured resources
+ dns-proxy DNS proxy object to use for resolving FQDNs
> network Network configuration
+ interface Import interface (member value or list of values enclosed in [ ])
> log-settings Log settings for shared gateway
> email Email log name
> format Custom formats for forwarded logs
+ config Configuration log value
+ hip-match HIP match log value
+ system System log value
+ threat Threat log value
+ traffic Traffic log value
> escaping
+ escape-character Escape character
+ escaped-characters List of characters to be escaped
> server Server address
+ and-also-to email address (e.g. [email protected])
+ display-name Display name
+ from email address (e.g. [email protected])
+ gateway IP address or FQDN of SMTP gateway to use
+ to email address (e.g. [email protected])
> profiles Profiles to configure
> alarm Alarm (critical, high, informational, low, or medium)
+ send-to-panorama Send to Panorama
> send-email Send email (using email setting value)
> send-snmptrap Send SNMP trap (using SNMP trap setting value)
> send-syslog Send syslog (using syslog setting value)
> traffic Traffic profile (any)
+ send-to-panorama Send to Panorama
> send-email Send email (using email setting value)
> send-snmptrap Send SNMP trap (using SNMP trap setting value)
> send-syslog Send syslog (using syslog setting value)
> snmptrap SNMP trap name
> version v2c and server address
+ community Community value
+ manager IP address or FQDN of SNMP manager to use
> version v3 and server address
+ authpwd Authentication Protocol Password
+ engineid A hex number in ASCII string
+ manager IP address or FQDN of SNMP manager to use
+ privpwd Privacy Protocol Password
+ user User value
> syslog syslog name
> format Custom formats for forwarded logs
+ config Configuration log value
+ hip-match HIP match log value
+ system System log value
+ threat Threat log value
+ traffic Traffic log value
> escaping
+ escape-character Escape character
+ escaped-characters List of characters to be escaped
> server Server address
+ facility Facility (LOG_LOCAL0, LOG_LOCAL1, LOG_LOCAL2, LOG_LOCAL3, LOG_LOCAL4,
LOG_LOCAL5, LOG_LOCAL6, LOG_LOCAL7, or LOG_USER)
+ port Port number (1-65535)
+ server IP address or FQDN of SYSLOG server to use
> rulebase Rule base for shared gateway
> dos Denial of Service (DoS) Protection Rules
+ description Description of rule set
+ disabled Disable the rule
+ negate-destination Negate destination
+ negate-source Negate source
+ schedule Schedule value
> action DoS rule action
- allow Allow all packets
Syntax
set network tunnel
{
global-protect-gateway <name> |
{
max-user <value> |
tunnel-interface <value> |
client |
{
dns-suffix-inherited {no | yes} |
dns-server |
{
primary {inherited | {<ip address/netmask> | <address object>}} |
secondary {inherited | {<ip address/netmask> | <address object>}}
}
dns-suffix <value> |
inheritance source <interface_name>
ip-pool {<ip_range> | {<ip address/netmask> | <address object>}} |
split-tunneling access-route {<ip address/netmask> | <address object>} |
wins-server <ip_address>
{
primary {inherited | {<ip address/netmask> | <address object>}} |
secondary {inherited | {<ip address/netmask> | <address object>}}
}
}
ipsec |
{
enable {no | yes} |
third-party-client
{
enable {no | yes} |
group-name <value> |
group-password <value> |
rekey-noauth {no | yes}
}
}
local-address
{
interface <value> |
floating-ip <ip_address> |
ip <ip_address>
}
}
global-protect-site-to-site <name> |
{
tunnel-interface <value> |
client |
{
accept-published-routes {no | yes} |
anti-replay {no | yes} |
config-refresh-interval <value> |
copy-tos {no | yes} |
dns-suffix-inherited {no | yes} |
ipsec-crypto-profile <name> |
dns-server |
{
primary {inherited | {<ip address/netmask> | <address object>}} |
secondary {inherited | {<ip address/netmask> | <address object>}}
}
dns-suffix <value> |
inheritance source <interface_name>
ip-pool {<ip_range> | {<ip address/netmask> | <address object>} | <value>} |
split-tunneling access-route {<ip address/netmask> | <address object>} |
tunnel-monitor |
{
destination-ip <ip_address> |
enable {no | yes} |
tunnel-monitor-profile <name>
}
valid-networks <value>
}
local-address
{
interface <value> |
floating-ip <ip_address> |
ip <ip_address>
}
}
ipsec <name> |
{
anti-replay {no |yes} |
copy-tos {no |yes} |
tunnel-interface <value> |
auto-key |
{
ipsec-crypto-profile {default | <name>} |
ike-gateway <name> |
proxy-id <name>
{
local {<ip address/netmask> | <address object>} |
remote {<ip address/netmask> | <address object>} |
protocol
{
number <value> |
tcp {local-port <port_number> | remote-port <port_number>} |
udp {local-port <port_number> | remote-port <port_number>} |
any
}
}
}
global-protect-satellite |
{
portal-address <value> |
external-ca
{
certificate-profile <value> |
local-certificate <value>
}
local-address
{
interface <value> |
floating-ip <ip_address> |
ip <ip_address>
}
publish-connected-routes enable {no | yes} |
publish-routes <value>
}
manual-key |
{
local-spi <value> |
remote-spi <value> |
ah |
{
md5 key <key_value> |
sha1 key <key_value> |
sha256 key <key_value> |
sha384 key <key_value> |
sha512 key <key_value>
}
esp |
{
authentication |
{
none
md5 key <key_value> |
sha1 key <key_value> |
sha256 key <key_value> |
sha384 key <key_value> |
sha512 key <key_value>
}
encryption
{
algorithm {3des | aes128 | aes128ccm16 | aes192 | aes256 | null} |
key <key_value>
}
}
local-address |
{
interface <value> |
floating-ip <ip_address> |
ip <ip_address>
}
peer-address <ip_address>
}
tunnel-monitor
{
destination-ip <ip_address> |
enable {no | yes} |
tunnel-monitor-profile <value>
}
}
}
Options
> global-protect-gateway GlobalProtect gateway networking specific configuration
+ max-user Max number of concurrent users logged in (1-20000)
+ tunnel-interface Apply GlobalProtect gateway tunnels to tunnel interface
> client GlobalProtect client configuration
+ dns-suffix-inherited Enable DNS suffix inheritance from a dynamic interface
> dns-server Primary and secondary Domain Name System (DNS) servers IP addresses (inherited or specify IP
address and network mask)
> dns-suffix DNS suffix for client (member value or list of values enclosed in [ ])
> inheritance Inherit settings from specified interface
+ source Dynamic interface name
> ip-pool IP subnets or ranges (x.x.x.x-y.y.y.y or IPv6-range, x.x.x.x/y or IPv6/netmask, or list of values enclosed in [
])
> split-tunneling Split tunneling settings
+ access-route Subnets need to be accessed by GlobalProtect clients (x.x.x.x/y or IPv6/netmask, or list of values
enclosed in [ ])
> wins-server Primary and secondary Windows Internet Name Service (WINS) servers IP addresses (inherited or
specify IP address and network mask)
> ipsec Internet Protocol Security (IPSec) traffic configuration
+ enable Enable/disable IPSec encapsulation of client traffic
> third-party-client Third-party IPSec Virtual Private Network (VPN) client configuration
+ enable Enable third-party client support
+ group-name Group name for hybrid authentication
+ group-password Group password for hybrid authentication
+ rekey-noauth Skip authentication on an IKE rekey
> local-address Tunnel local IP configuration
+ interface Local gateway end-point
> floating-ip Floating IP address in HA Active-Active configuration
> ip Specify exact IP address if interface has multiple addresses
> global-protect-site-to-site GlobalProtect site to site networking specific configuration
+ tunnel-interface Apply GlobalProtect site-to-site tunnels to specified tunnel interface
> client GlobalProtect site-to-site configuration
+ accept-published-routes Whether Gateway should accept routes published by Satellite
+ anti-replay Enable Anti-Replay check on this tunnel
+ config-refresh-interval GlobalProtect gateway configuration refresh interval, in hours (1-48)
+ copy-tos Copy IP TOS bits from inner packet to IPSec packet (not recommended)
+ dns-suffix-inherited Enable DNS suffix inheritance from dynamic interface
+ ipsec-crypto-profile IPSec crypto profile name
> dns-server Primary and secondary Domain Name System (DNS) servers IP addresses (inherited or specify IP
address and network mask)
> dns-suffix DNS suffix for client (member value or list of values enclosed in [ ])
> inheritance Inherit settings from specified interface
+ source Dynamic interface name
> ip-pool IP subnets or ranges (x.x.x.x-y.y.y.y or IPv6-range, x.x.x.x/y or IPv6/netmask, or list of values enclosed in [
])
Syntax
set network virtual-router <name>
{
admin-dists |
{
ebgp <value> |
ibgp <value> |
ospf-ext <value> |
ospf-int <value> |
ospfv3-ext <value> |
ospfv3-int <value> |
rip <value> |
static <value> |
static-ipv6 <value> |
}
interface <value> |
multicast | [refer to separate multicast page below]
protocol {bgp | ospf | ospfv3 | redist-profile | redist-profile-ipv6 | rip} | [refer to
separate protocol pages below]
routing-table {ip |ipv6} static-route <name>
{
admin-dist <value> |
destination {<ip address/netmask> | <address object>}
interface <value> |
metric <value> |
nexthop |
{
ip-address <ip_address> |
next-vr <value> |
discard
}
option no-install
}
}
Options
<name> Configures a virtual router with the specified name
> admin-dists Administrative distances
+ ebgp Administrative distance used for eBGP routes (10-240)
+ ibgp Administrative distance used for iBGP routes (10-240)
+ ospf-ext Administrative distance used for OSPF external routes (10-240)
+ ospf-int Administrative distance used for OSPF internal routes (10-240)
+ ospfv3-ext Administrative distance used for OSPF external routes (10-240)
+ ospfv3-int Administrative distance used for OSPF internal routes (10-240)
Syntax
set network virtual-router <name> multicast
{
enable {no | yes} |
interface-group <name> |
{
description <value> |
group-permission |
{
any-source-multicast <name> |
{
group-address {<ip address/netmask> | <address object>} |
included {no | yes}
}
source-specific-multicast <name>
{
group-address {<ip address/netmask> | <address object>} |
included {no | yes} |
source-address {<ip address/netmask> | <address object>}
}
}
igmp |
{
enable {no | yes} |
immediate-leave {no | yes} |
last-member-query-interval
max-groups {unlimited | <value>} |
max-query-response-time <value> |
max-sources {unlimited | <value>} |
query-interval <value> |
robustness {1 | 2 | 3 | 4 | 5 | 6 | 7} |
router-alert-policing {no | yes} |
version {1 | 2 | 3}
{
interface <value> |
pim
{
assert-interval <value> |
bsr-border {no | yes} |
dr-priority <value> |
enable {no | yes} |
hello-interval <value> |
join-prune-interval <value> |
allowed-neighbors {<ip address/netmask> | <address object>}
}
}
rp |
{
external-rp <ip_address> |
{
override {no | yes}
group-addresses <value> |
}
local-rp
{
candidate-rp |
{
address <value> |
advertisement-interval <value> |
interface <value> |
priority <value>
group-addresses <value> |
}
static-rp
{
address <value> |
interface <value> |
override {no | yes}
group-addresses <value> |
}
}
}
spt-threshold {<ip address/netmask> | <address object>} {threshold {0 | never |
<value>}} |
ssm-address-space <name>
{
group-address {<ip address/netmask> | <address object>} |
included {no | yes}
}
}
Options
<name> Configures a virtual router with the specified name
+ enable Enable multicast protocol
> interface-group Multicast interface group name
+ description Description text
> group-permission ASM/SSM group permission
> any-source-multicast Array of ASM group rules
+ group-address Group address/prefix (IP address and network mask)
+ included Included (no or yes; default = yes)
> source-specific-multicast Array of SSM group-source pair rules
+ group-address Group address/prefix (IP address and network mask)
+ included Included (no or yes; default = yes)
+ source-address Source address/prefix (IP address and network mask)
> igmp Internet Group Management Protocol (IGMP) configuration
+ enable Enable IGMP; default = yes
+ immediate-leave Leave group immediately when a leave message is received; default = no
+ last-member-query-interval Interval between group/source specific query messages (including those sent in
Syntax
set network virtual-router <name> protocol bgp
{
allow-redist-default-route {no | yes} |
enable {no | yes} |
install-route {no | yes} |
local-as <value> |
reject-default-route {no | yes} |
router-id <ip_address> |
auth-profile <name> {secret <value>} |
dampening-profile <name> |
{
cutoff <value> |
decay-half-life-reachable <value> |
decay-half-life-unreachable <value> |
enable {no | yes} |
max-hold-time <value> |
reuse <value>
}
peer-group <name> |
{
aggregated-confed-as-path {no |yes} |
enable {no |yes} |
soft-reset-with-stored-info {no |yes} |
peer <name> |
{
enable {no |yes} |
max-prefixes {unlimited | <value>} |
peer-as <value> |
peering-type {bilateral | unspecified} |
reflector-client {client | meshed-client | non-client} |
connection-options
{
authentication <name> |
hold-time <value> |
idle-hold-time <value> |
keep-alive-interval <value> |
multihop <value> |
open-delay-time <value> |
incoming-bgp-connection |
{
allow {no | yes} |
remote-port <port_number>
}
outgoing-bgp-connection
{
allow {no | yes} |
local-port <port_number>
}
}
local-address {interface <value> | ip <ip_address>} |
peer-address ip <ip_address>
}
type
{
ebgp |
{
export-nexthop {resolve | use-self} |
import-nexthop {original | use-peer} |
remove-private-as {no | yes}
}
ebgp-confed {export-nexthop {original | use-self}} |
ibgp {export-nexthop {original | use-self}} |
ibgp-confed {export-nexthop {original | use-self}}
}
}
policy |
{
aggregation {address <aggregating_address>} |
{
as-set {no | yes} |
enable {no | yes} |
prefix {<ip address/netmask> | <address object>} |
summary {no | yes} |
advertise-filters <name> |
{
enable {no | yes} |
match med <value> |
match address-prefix {<ip address/netmask> | <address object>}
{exact {no | yes}} |
match as-path {regex <value>} |
match community {regex <value>} |
match extended-community {regex <value>}
match from-peer <name> |
match nexthop {<ip address/netmask> | <address object>} |
}
aggregate-route-attributes |
{
as-path-limit <value> |
local-preference <value> |
med <value> |
nexthop <ip_address> |
origin {egp | igp | incomplete} |
weight <value> |
as-path {prepend <value> | none} |
community |
{
append {local-as | no-advertise | no-export | nopeer | <value>} |
overwrite {local-as | no-advertise | no-export | nopeer |
<value>} |
remove-regex <value> |
none |
remove-all
}
extended-community
{
append <values> |
overwrite <value> |
remove-regex <value> |
none |
remove-all
}
}
suppress-filters <name>
{
enable {no | yes} |
match med <value> |
match address-prefix {<ip address/netmask> | <address object>}
{exact {no | yes}} |
match as-path {regex <value>} |
match community {regex <value>} |
match extended-community {regex <value>}
match from-peer <name> |
match nexthop {<ip address/netmask> | <address object>} |
}
}
conditional-advertisement {policy <name>} |
{
enable {no | yes} |
advertise-filters <name> |
{
enable {no | yes} |
match med <value> |
match address-prefix {<ip address/netmask> | <address object>} |
match as-path {regex <value>} |
match community {regex <value>} |
match extended-community {regex <value>}
match from-peer <name> |
match nexthop {<ip address/netmask> | <address object>} |
}
non-exist-filters <name>
{
enable {no | yes} |
match med <value> |
match address-prefix {<ip address/netmask> | <address object>} |
match as-path {regex <value>} |
match community {regex <value>} |
match extended-community {regex <value>}
match from-peer <name> |
match nexthop {<ip address/netmask> | <address object>} |
}
used-by <member_value> |
}
allow |
{
dampening <value> |
update as-path-limit <value>} |
update local-preference <value>} |
update med <value>} |
update nexthop <ip_address>} |
update origin {egp | igp | incomplete}} |
update weight <value> |
update as-path |
{
prepend <value> |
remove-and-prepend <value> |
none |
remove
}
update community |
{
append {local-as | no-advertise | no-export | nopeer |
<value>} |
overwrite {local-as | no-advertise | no-export | nopeer |
<value>} |
remove-regex <value> |
none |
remove-all
}
update extended-community |
{
append <value> |
overwrite <value> |
remove-regex <value> |
none |
remove-all
}
}
deny
}
match
{
med <value> |
address-prefix {<ip address/netmask> | <address object>} {exact {no
| yes}} |
as-path {regex <value>} |
community {regex <value>} |
extended-community {regex <value>}
from-peer <name> |
nexthop {<ip address/netmask> | <address object>} |
}
used-by <member_value> |
}
}
redist-rules {{<ip address/netmask> | <address object>} | <value>} |
{
enable {no | yes} |
metric <value> |
set-as-path-limit <value> |
set-local-preference <value> |
set-med <value> |
set-origin {egp | igp | incomplete}
set-community {local-as | no-advertise | no-export | nopeer | <value>} |
set-extended-community <value> |
}
routing-options
{
as-format {2-byte | 4-byte} |
confederation-member-as <value> |
default-local-preference <value> |
reflector-cluster-id <ip_address> |
aggregate {aggregate-med {no | yes}} |
graceful-restart |
{
enable {no | yes} |
local-restart-time <value> |
max-peer-restart-time <value> |
stale-route-time <value>
}
med
{
always-compare-med {no | yes} |
deterministic-med-comparison {no | yes}
}
}
}
Options
<name> Configures a virtual router with the specified name
+ allow-redist-default-route Allow redistribute default route to BGP
+ enable Enable (no or yes)
+ install-route Populate BGP learned route to global route table
+ local-as Local Autonomous system (AS) number (1-4294967295)
+ reject-default-route Do not learn default route from BGP
+ router-id Router id of this BGP instance (x.x.x.x)
> auth-profile BGP authentication profiles
+ secret Shared secret for the TCP MD5 authentication
> dampening-profile Route flap dampening profiles
+ cutoff Cutoff threshold value (0-1000)
+ decay-half-life-reachable Decay half-life while reachable, in seconds (1-3600)
+ decay-half-life-unreachable Decay half-life while unreachable, in seconds (1-3600)
+ enable Enable (no or yes)
+ max-hold-time maximum of hold-down time, in seconds (1-3600)
+ reuse reuse threshold value (0-1000)
> peer-group Peer group configuration
+ aggregated-confed-as-path Peers understand aggregated confederation AS path
+ enable Enable (no or yes)
+ soft-reset-with-stored-info Soft reset with stored info
> peer Peer configuration
+ enable Enable (no or yes)
Syntax
set network virtual-router <name> protocol ospf
{
allow-redist-default-route {no | yes} |
enable {no | yes} |
reject-default-route {no | yes} |
rfc1583 {no | yes} |
router-id <ip_address> |
area <ip_address> |
{
interface <interface_name> |
{
authentication <name> |
dead-counts <value> |
enable {no | yes} |
hello-interval <value> |
metric <value> |
passive {no | yes} |
priority <value> |
retransmit-interval <value> |
transit-delay <value> |
link-type {broadcast | p2mp | p2p} |
neighbor <ip_address>
}
range {<ip address/netmask> | <address object>} {advertise | suppress} |
type |
{
nssa |
{
accept-summary {no | yes} |
default-route |
{
advertise |
{
metric <value> |
type {ext-1 | ext-2}
}
disable
}
nssa-ext-range {<ip address/netmask> | <address object>} {advertise |
suppress}
}
stub
{
accept-summary {no | yes} |
default-route
{
advertise {metric <value>} |
disable
}
}
normal
}
virtual-link <name>
{
authentication <name> |
dead-counts <value> |
enable {no | yes} |
hello-interval <value> |
neighbor-id <ip_address>
retransmit-interval <value> |
transit-area-id <value> |
transit-delay <value>
}
}
auth-profile <name> |
{
md5 <value> {key <value> | preferred {no | yes}} |
password <value>
}
export-rules {{<ip address/netmask> | <address object>} | <value>} |
{
new-path-type {ext-1 | ext-2} |
new-tag {{<ip address/netmask> | <address object>} | <value>} |
metric <value>
{
graceful-restart{
enable {yes | no}
grace-period [5-1800]
max-neighbor-restart-time [5-1800]
helper-enable {yes | no}
strict-LSA-checking-enable {yes | no}
}
timers {spf-calculation <value> | lsa-interval <value>}
}
Options
<name> Configures a virtual router with the specified name
+ allow-redist-default-route Allow redistribute default route to OSPF
+ enable Enable configuration
+ reject-default-route Do not learn default route from OSPF
+ rfc1583 RFC-1583 compatibility
+ router-id Router ID of this OSPF instance (x.x.x.x)
> area Area configuration (x.x.x.x or IPv6)
> interface Protocol configuration for interface(s)
+ authentication Authentication options
+ dead-counts Number of lost hello packets to declare router down (3-20)
+ enable Enable OSPF in this interface
Syntax
set network virtual-router <name> protocol ospfv3
{
allow-redist-default-route {no | yes} |
disable-transit-traffic {no | yes} |
enable {no | yes} |
reject-default-route {no | yes} |
router-id <ip_address> |
area <ip_address> |
{
interface <interface_name> |
{
authentication <name> |
dead-counts <value> |
enable {no | yes} |
hello-interval <value> |
metric <value> |
passive {no | yes} |
priority <value> |
retransmit-interval <value> |
transit-delay <value> |
link-type {broadcast | p2mp | p2p} |
neighbor <ip_address>
}
range {<ip address/netmask> | <address object>} {advertise | suppress} |
type |
{
nssa |
{
accept-summary {no | yes} |
default-route |
{
advertise |
{
metric <value> |
type {ext-1 | ext-2}
}
disable
}
nssa-ext-range {<ip address/netmask> | <address object>} {advertise |
suppress}
}
stub
{
accept-summary {no | yes} |
default-route
{
advertise {metric <value>} |
disable
}
}
normal
}
virtual-link <name>
{
authentication <name> |
dead-counts <value> |
enable {no | yes} |
hello-interval <value> |
neighbor-id <ip_address>
retransmit-interval <value> |
transit-area-id <value> |
transit-delay <value>
}
}
auth-profile <name> |
{
spi <value> |
ah |
{
md5 key <key_value> |
sha1 key <key_value> |
sha256 key <key_value> |
sha384 key <key_value> |
sha512 key <key_value>
}
esp |
{
authentication |
{
none
md5 key <key_value> |
sha1 key <key_value> |
sha256 key <key_value> |
sha384 key <key_value> |
sha512 key <key_value>
}
encryption
{
algorithm {3des | aes128 | aes128ccm16 | aes192 | aes256 |
null} |
key <key_value>
}
}
}
export-rules {{<ip address/netmask> | <address object>} | <value>} |
{
new-path-type {ext-1 | ext-2} |
new-tag {{<ip address/netmask> | <address object>} | <value>} |
metric <value>
{
graceful-restart{
enable {yes | no}
grace-period [5-1800]
max-neighbor-restart-time [5-1800]
helper-enable {yes | no}
strict-LSA-checking-enable {yes | no}
}
timers {spf-calculation <value> | lsa-interval <value>}
}
Options
<name> Configures a virtual router with the specified name
+ allow-redist-default-route Allow redistribute default route to OSPF
+ disable-transit-traffic Specify whether OSPFv3 should set the R- and V6-bits in its Router-LSAs
+ enable Enable configuration
+ reject-default-route Do not learn default route from OSPF
+ router-id Router ID of this OSPF instance (x.x.x.x)
> area Area configuration (x.x.x.x or IPv6)
+ authentication Options for authentication
> interface Protocol configuration for interface(s)
+ authentication Authentication options
+ dead-counts Number of lost hello packets to declare router down (3-20)
+ enable Enable OSPF in this interface
+ hello-interval Interval to send Hello packets, in seconds (0-3600)
+ instance-id OSPFv3 instance ID
+ metric Cost of OSPF interface (1-65535)
+ passive Suppress the sending of hello packets in this interface
+ priority Priority for OSPF designated router selection (0-255)
+ retransmit-interval Interval to retransmit LSAs, in seconds (1-3600)
+ transit-delay Estimated delay to transmit LSAs, in seconds (1-3600)
> link-type Link type (broadcast, p2mp, or p2p)
> neighbor Neighbor configuration (x.x.x.x or IPv6)
> auth-profile OSPFvw authentication profiles
+ spi SPI for both inbound and outbound SA, hex format xxxxxxxx.
> ah AH options
> md5 Use OSPF MD5 authentication method (0-255 index of MD5 key)
> sha1 NIST rating 128-bit strength
> sha256 NIST rating 256-bit strength
> sha384 NIST rating over 256-bit strength
> sha512 NIST rating over 256-bit strength
> esp ESP options
> authentication Authentication algorithm
> md5 Use OSPF MD5 authentication method (0-255 index of MD5 key)
> sha1 NIST rating 128-bit strength
> sha256 NIST rating 256-bit strength
> sha384 NIST rating over 256-bit strength
> sha512 NIST rating over 256-bit strength
> none No authentication
> encryption Encryption algorithm
+ algorithm (specify 3des | aes128 | aes128ccm16 | aes192 | aes256 | null)
+ key (specify key value)
Syntax
set network virtual-router <name> protocol redist-profile <name>
{
priority <value> |
action {redist {new-metric <value>} | no-redist} |
filter
{
bgp |
{
community {local-as | no-advertise | no-export | nopeer | <value>} |
extended-community <value>
}
destination {<ip address/netmask> | <address object>} |
interface <value> |
nexthop {<ip address/netmask> | <address object>} |
ospf
{
area <ip_address> |
path-type {ext-1 | ext-2 | inter-area | intra-area | <list>} |
tag {{<ip address/netmask> | <address object>} | <value>}
}
type <bgp | connect | ospf | rip | static | <type> |
}
}
Options
<name> Configures a virtual router with the specified name
redist-profile Route redistribution profile name
+ priority Priority (1-255)
> action Action taken when filter is matched
> redist Redistribute when this rule matched
+ new-metric New metric value (1-255)
no-redist Do not redistribute when this rule matched
> filter Define filter criteria for redistribution rules
> bgp Specify candidate BGP routes' attributes
> community BGP community
[ Start a list of values
local-as Well known community value: NO_EXPORT_SUBCONFED
no-advertise Well known community value: NO_ADVERTISE
no-export Well known community value: NO_EXPORT
nopeer Well known community value: NOPEER
<value> 32-bit value in hex, or in AS:VAL format, AS and VAL each in 0-65535 range
> extended-community BGP extended-community
[ Start a list of values
<value> 64-bit value in hex, or one of TYPE:AS:VAL, TYPE:IP:VAL, TYPE:A.B:VAL format, TYPE
is 'target', 'origin' or decimal number (0-65535)
> destination Specify candidate routes' destination networks (subnet match) (x.x.x.x/y or IPv6/netmask or list
enclosed in [ ])
> interface Specify candidate routes' interfaces (member value or list enclosed in [ ])
> nexthop Specify candidate routes' next-hop addresses (subnet match) (x.x.x.x/y or IPv6/netmask or list enclosed
in [ ])
> ospf Specify candidate OSPF routes' attributes
+ area Area (x.x.x.x or IPv6 or list enclosed in [ ])
+ path-type Path-type (ext-1, ext-2, inter-area, intra-area, or list enclosed in [ ])
+ tag Tag (x.x.x.x/y, IPv6/netmask, value between 1-4294967295, or list enclosed in [ ])
> type Specify candidate routes' types (BGP, connect, OSPF, RIP, static, or list enclosed in [ ])
Syntax
set network virtual-router <name> protocol redist-profile <name>
{
priority <value> |
action {redist {new-metric <value>} | no-redist} |
filter
{
destination {<ip address/netmask> | <address object>} |
interface <value> |
nexthop {<ip address/netmask> | <address object>} |
type <bgp | connect | ospf | rip | static | <type> |
}
}
Options
<name> Configures a virtual router with the specified name
redist-profile Route redistribution profile name
+ priority Priority (1-255)
> action Action taken when filter is matched
> redist Redistribute when this rule matched
+ new-metric New metric value (1-255)
no-redist Do not redistribute when this rule matched
> filter Define filter criteria for redistribution rules
> destination Specify candidate routes' destination networks (subnet match) (x.x.x.x/y or IPv6/netmask or list
enclosed in [ ])
> interface Specify candidate routes' interfaces (member value or list enclosed in [ ])
> nexthop Specify candidate routes' next-hop addresses (subnet match) (x.x.x.x/y or IPv6/netmask or list enclosed
in [ ])
> type Specify candidate routes' types (connect, static, or list enclosed in [ ])
Syntax
set network virtual-router <name> protocol rip
{
allow-redist-default-route {no | yes} |
enable {no | yes} |
reject-default-route {no | yes} |
auth-profile <name>
{
md5 <value> {key <value> | preferred {no | yes}} |
password <value>
}
export-rules metric <value> |
interface <interface_name>
{
authentication <name> |
enable {no | yes} |
mode {normal | passive | send-only} |
default-route {advertise {metric <value>} | disable}
}
timers
{
delete-intervals <value> |
expire-intervals <value> |
interval-seconds <value> |
update-intervals <value>
}
}
Options
<name> Configures a virtual router with the specified name
+ allow-redist-default-route Allow redistribute default route to RIP
+ enable Enable configuration
+ reject-default-route do not learn default route from RIP
> auth-profile RIP authentication profiles
> md5 Use RIP MD5 authentication method (0-255 index of MD5 key)
+ key Key for the authentication
+ preferred Use this key when sending packet
> password Simple password authentication
> export-rules Redistribution rules for export through RIP (metric value 1-16)
> interface Protocol Configuration for Interface(s)
+ authentication Authentication options
+ enable Enable interface
+ mode Mode selection
normal Send and receive
Syntax
set network virtual-wire {default-vwire | <name>}
{
interface1 <value> |
interface2 <value> |
tag-allowed <value> |
link-state-pass-through enable {no | yes} |
multicast-firewalling enable {no | yes}
}
Options
default-vwire Configures a default virtual wire
<name> Configures a virtual wire with the specified name
+ interface1 Interface 1 name
+ interface2 Interface 2 name
+ tag-allowed Allowed 802.1q VLAN tags (0-4094)
> link-state-pass-through Pass link state change from one interface to another
> multicast-firewalling Firewalling for non-unicast traffic
Syntax
set network vlan <name>
{
interface <value> |
mac <mac_address> interface <name> |
virtual-interface
{
interface <value> |
l3-forwarding {no | yes}
}
}
Options
<name> VLAN identifier
+ interface Interface(s) within this VLAN, ex. ethernet1/5 (member value or list of values enclosed in [ ])
> mac Static MAC configuration (MAC address format xx:xx:xx:xx:xx:xx)
+ interface Interface name
> virtual-interface Virtual interface for this VLAN
+ interface Virtual interface identifier, ex. vlan 1
+ l3-forwarding Enable Layer3 forwarding on this virtual interface
set ocsp-responder
set ocsp-responder
Configures the Online Certificate Status Protocol (OCSP) responder, which defines a server that will be used to
verify the revocation status of certificates issues by PAN-OS devices.
Syntax
set ocsp-responder <name> {host-name <name>}
Options
<name> OCSP responder identifier
+ host-name Host name value
set panorama
set panorama
(Panorama only) Configures Panorama firewall management.
For information about the syntax and options for each configuration available for Panorama, refer to its command
page in this chapter.
Syntax
set panorama
{
authentication-profile |
authentication-sequence |
certificate |
certificate-profile |
log-settings |
server-profile
}
Options
> authentication-profile [refer to set shared authentication-profile on page 249]
> authentication-sequence [refer to set shared authentication-sequence on page 251]
> certificate [refer to set shared certificate on page 254]
> certificate-profile [refer to set shared certificate-profile on page 255]
> log-settings [refer to set shared log-settings on page 258]
> server-profile [refer to set shared server-profile on page 274]
set pdf-summary-report
set pdf-summary-report
Specifies format settings for PDF summary reports.
Syntax
set pdf-summary-report <name>
{
custom-widget <name> |
{
chart-type {bar | line | pie | table} |
column <value> |
row <value>
}
footer {note <value>} |
header {caption <value>}|
}
Options
<name> PDF report to configure
> custom-widget Report widget layout information
+ chart-type Chart type (bar, line, pie, or table)
+ column Column number (1-3)
+ row Row number (1-6)
> footer Footer information for PDF summary layout
+ note Static string to be printed as a note
> header Header information for PDF summary layout
+ caption Caption for the layout
set profile-group
set profile-group
Specifies settings for sets of security profiles that are treated as a unit and added to security policies. For example,
you can create a threats security profile group that includes profiles for antivirus, anti-spyware, and vulnerability
and then create a security policy that includes the threats profile.
Syntax
set profile-group <name>
{
data-filtering <value> |
file-blocking <value> |
spyware <value> |
url-filtering <value> |
virus <value> |
vulnerability <value>
}
Options
<name> Profile group to configure
+ data-filtering Data filtering profile to include in the group, or list of profiles enclosed in [ ]
+ file-blocking File blocking profile to include in the group, or list of profiles enclosed in [ ]
+ spyware Spyware default profile or profile name to include in the group, or list of profiles enclosed in [ ]
+ url-filtering URL filtering default profile or profile name to include in the group, or list of profiles enclosed in [ ]
+ virus AV default profile or profile name to include in the group, or list of profiles enclosed in [ ]
+ vulnerability Vulnerability default profile or profile name to include in the group, or list of profiles enclosed in [ ]
set profiles
set profiles
Specifies settings for security profiles that can be applied to security policies.
Syntax
set profiles
{
custom-url-category <name> |
{
description <value> |
list <value>
}
data-filtering <name> |
{
data-capture {no | yes} |
description <value> |
rules <name>
{
alert-threshold <value> |
block-threshold <value> |
data-object <value> |
direction {both | download | upload} |
application {any | <value>} |
file-type {any | <value>}
}
}
data-objects <name> |
{
description <value> |
credit-card-numbers {weight <value>} |
pattern <name> {regex <value> | weight <value>} |
social-security-numbers {weight <value>} |
social-security-numbers-without-dash {weight <value>}
} |
decryption <name> |
{
interface <name> |
ssh-proxy |
{
block-if-no-resource {no | yes} |
block-ssh-errors {no | yes} |
block-unsupported-alg {no | yes} |
block-unsupported-version {no | yes}
}
ssl-forward-proxy |
{
block-client-cert {no | yes} |
block-expired-certificate {no | yes} |
block-if-no-resource {no | yes} |
block-unsupported-cipher {no | yes} |
block-unsupported-version {no | yes} |
set profiles
set profiles
activate-rate <value> |
alarm-rate <value> |
maximal-rate <value>
block {duration <value>}
}
syn-cookies
{
activate-rate <value> |
alarm-rate <value> |
maximal-rate <value>
block {duration <value>}
}
}
udp
{
enable {no | yes} |
red
{
activate-rate <value> |
alarm-rate <value> |
maximal-rate <value>
block {duration <value>}
}
}
}
resource
{
sessions
{
enabled {no | yes} |
max-concurrent-limit <value>
}
}
}
file-blocking <name> |
{
description <value> |
rules <name>
{
action {alert | block | continue} |
direction {both | download | upload} |
application {any | <value>} |
file-type {any | <value>}
}
}
hip-objects <name> |
{
description <value> |
anti-spyware |
{
exclude-vendor {no | yes} |
criteria |
{
is-installed {no | yes} |
set profiles
set profiles
set profiles
set profiles
}
}
network-info criteria {is <value> | is-not <value>}
patch-management
{
exclude-vendor {no | yes} |
criteria |
{
is-enabled {no | not-available | yes} |
is-installed {no | yes}|
missing-patches
{
check {has-all | has-any | has-none} |
patches <value> |
severity
{
greater-equal <value> |
greater-than <value> |
is <value> |
is-not <value> |
less-equal <value> |
less-than <value>
}
}
}
vendor <name> {product <name>}
}
}
hip-profiles <name> |
{
description <value> |
match <value>
}
spyware <name> |
{
description <value> |
botnet-domains
{
packet-capture {no | yes} |
passive-dns {no | yes} |
action {alert | allow | block} |
threat-exception <threat_id>
}
rules <value>
{
category {any | <value>} |
packet-capture {no | yes} |
threat-name {any | <value>} |
action
{alert |
allow |
block |
default |
sinkhole
set profiles
set profiles
set profiles
interval <value> |
threshold <value> |
track-by {destination | source | source-and-destination}
}
}
}
}
Options
> custom-url-category Custom URL category profiles
+ description Profile description
+ list List; specify member value or list of values enclosed in [ ]
> data-filtering Data filtering profiles
+ data-capture Data capture option
+ description Profile description
> rules Data filtering rules for the profile
+ alert-threshold Alert threshold value (0-65535)
+ block-threshold Block threshold value (0-65535)
+ data-object Data object value
+ direction Direction for data filtering (both, download, or upload)
> application Application name or list of values enclosed in [ ]; press <tab> for list of applications; option to include
all applications (any)
> file-type File type or list of values enclosed in [ ]; press <tab> for list of file types; option to include all types (any)
> data-objects Data objects profiles
+ description Description of the profile
> credit-card-numbers Credit card numbers; option to specify weight (0-255)
> pattern Pattern; option to specify a regular expression value and weight (0-255)
> social-security-numbers Social security numbers; option to specify weight (0-255)
> social-security-numbers-without-dash Social security numbers without dash; option to specify weight (0-255)
> decryption Decryption profiles
> interface <name>
> ssh-proxy Secure Shell (SSH) proxy profile settings
+ block-if-no-resource Whether to block sessions if device has not enough resources
+ block-ssh-errors Whether to block sessions if SSH errors are encountered
+ block-unsupported-alg Whether to block sessions if SSH algorithm is not supported
+ block-unsupported-version Whether to block sessions if ssh version is not supported
> ssl-forward-proxy Secure Socket Layer (SSL) forwarding proxy
+ block-client-cert Whether to block sessions if client certificate authentication is used
+ block-expired-certificate Whether to block sessions if server's certificate is expired
+ block-if-no-resource Whether to block sessions if device has not enough resources
+ block-unsupported-cipher Whether to block sessions if SSL cipher suite is not supported
+ block-unsupported-version Whether to block sessions if SSL version is not supported
+ block-untrusted-issuer Whether to block sessions if server's certificate is issued by untrusted CA
+ restrict-cert-exts Whether to restrict certificates' extensions
> ssl-inbound-proxy SSL inbound proxy
+ block-if-no-resource Whether to block sessions if device has not enough resources
+ block-unsupported-cipher Whether to block sessions if SSL cipher suite is not supported
+ block-unsupported-version Whether to block sessions if SSL version is not supported
+ forwarded-only Mirror after security policy allow
> dos-protection Denial of Service (DoS) protection profiles
+ description Description of the profile
+ type Type (aggregate or classified)
> flood Flood protection
set profiles
set profiles
set profiles
set profiles
set profiles
set profiles
set region
set region
Defines a custom region on the firewall. The firewall supports creation of policy rules that apply to specified
countries or other regions. The region is available as an option when specifying source and destination for security
policies, SSL decryption policies, and DoS policies. A standard list of countries is available by default. This
command allows you to define custom regions to include as options for security policy rules.
Syntax
set region <code>
{
address {<value> | {<ip address/netmask> | <address object>} | <ip_range>} |
geo-location |
{
latitude <coordinate> |
longitude <coordinate>
}
}
Options
<code> Region to configure (two-character code; press <tab> for list)
+ address IP address and network mask (x.x.x.x/y or IPv6/netmask), IP address range (x.x.x.x-y.y.y.y or IPv6-range), or list of
values enclosed in [ ]
> geo-location Device geographic location
+ latitude Latitude coordinate
+ longitude Longitude coordinate
set report-group
set report-group
Specifies settings for report groups. Report groups allow you to create sets of reports that the system can compile and
send as a single aggregate PDF report with an optional title page and all the constituent reports included.
Syntax
set report-group <name> |
{
title-page {no | yes} |
custom-widget <value> |
{
custom-report <value> |
log-view <value> |
pdf-summary-report <value>
}
predefined user-activity-report |
variable <name> {value <value>}
}
Options
<name> Report group to configure
+ title-page Include title page
> custom-widget Custom-widget value
> custom-report Custom report value
> log-view Log view value
> pdf-summary-report PDF summary report value
> predefined Predefined user activity report
> variable Variable name; option to include a value
set reports
set reports
Specifies settings for generating reports.
Syntax
set reports <name>
{
caption <value> |
disabled {no | yes} |
end-time <value> |
frequency daily |
period {last-12-hrs | last-15-minutes | last-24-hrs | last-30-days | last-60-seconds
| last-7-calendar-days | last-7-days | last-calendar-day | last-calendar-month |
last-calendar-week | last-hour} |
query <value> |
start-time <value> |
topm <value> |
topn <value> |
type
{
appstat |
{
group-by {category-of-name | container-of-name | day-of-receive_time | hourof-receive_time | name | quarter-hour-of-receive_time | risk | risk-of-name
| subcategory-of-name | technology-of-name | vsys} |
sortby {nbytes | npkts | nsess | nthreats} |
aggregate-by {category-of-name | container-of-name | day-of-receive_time |
hour-of-receive_time | name | quarter-hour-of-receive_time | risk | riskof-name | subcategory-of-name | technology-of-name | vsys | <value>} |
labels <value> |
values {nbytes | npkts | nsess | nthreats | <value>}
}
data |
{
group-by {action | app | category-of-app | container-of-app | day-ofreceive_time | direction | dport | dst | dstloc | dstuser | from | hour-ofreceive_time | inbound_if | misc | natdport | natdst | natsport | natsrc |
outbound_if | proto | quarter-hour-of-receive_time | risk-of-app | rule |
severity | sport | src | srcloc | srcuser | subcategory-of-app | subtype |
technology-of-app | threatid | to | vsys} |
sortby repeatcnt |
aggregate-by {action | app | category-of-app | container-of-app | day-ofreceive_time | direction | dport | dst | dstloc | dstuser | from | hour-ofreceive_time | inbound_if | misc | natdport | natdst | natsport | natsrc |
outbound_if | proto | quarter-hour-of-receive_time | risk-of-app | rule |
severity | sport | src | srcloc | srcuser | subcategory-of-app | subtype |
technology-of-app | threatid | to | vsys | <value>} |
labels <value> |
values {repeatcnt | <value>}
}
hipmatch |
set reports
{
group-by {day-of-receive_time | hour-of-receive_time | machinename | matchname
| matchtype | quarter-hour-of-receive_time | src | srcuser | vsys} |
last-match-by time_generated |
aggregate-by {day-of-receive_time | hour-of-receive_time | machinename |
matchname | matchtype | quarter-hour-of-receive_time | src | srcuser | vsys
| <value>} |
labels <value> |
values {repeatcnt | <value>}
}
threat |
{
group-by {action | app | category-of-app | container-of-app | day-ofreceive_time | direction | dport | dst | dstloc | dstuser | from | hour-ofreceive_time | inbound_if | misc | natdport | natdst | natsport | natsrc |
outbound_if | proto | quarter-hour-of-receive_time | risk-of-app | rule |
severity | sport | src | srcloc | srcuser | subcategory-of-app | subtype |
technology-of-app | threatid | to | vsys} |
sortby repeatcnt |
aggregate-by {action | app | category-of-app | container-of-app | day-ofreceive_time | direction | dport | dst | dstloc | dstuser | from | hour-ofreceive_time | inbound_if | misc | natdport | natdst | natsport | natsrc |
outbound_if | proto | quarter-hour-of-receive_time | risk-of-app | rule |
severity | sport | src | srcloc | srcuser | subcategory-of-app | subtype |
technology-of-app | threatid | to | vsys | <value>} |
labels <value> |
values {repeatcnt | <value>}
}
thsum |
{
group-by {app | category-of-app | container-of-app | day-of-receive_time | dst
| dstloc | dstuser | from | hour-of-receive_time | quarter-hour-ofreceive_time | risk-of-app | rule | severity-of-threatid | src | srcloc |
srcuser | subcategory-of-app | subtype | technology-of-app | threatid | to
| vsys} |
sortby count |
aggregate-by {app | category-of-app | container-of-app | day-of-receive_time |
dst | dstloc | dstuser | from | hour-of-receive_time | quarter-hour-ofreceive_time | risk-of-app | rule | severity-of-threatid | src | srcloc |
srcuser | subcategory-of-app | subtype | technology-of-app | threatid | to
| vsys | <value>} |
labels <value> |
values {count | <value>}
}
traffic |
{
group-by {action | app | category | category-of-app | container-of-app | dayof-receive_time | dport | dst | dstloc | dstuser | from | hour-ofreceive_time | inbound_if | natdport | natdst | natsport | natsrc |
outbound_if | proto | quarter-hour-of-receive_time | risk-of-app | rule |
sessionid | sport | src | srcloc | srcuser | subcategory-of-app |
technology-of-app | to | vsys} |
sortby {bytes | bytes_received | bytes_sent | elapsed | packets |
ptks_received | pkts_sent | repeatcnt} |
set reports
Options
<name> Report to configure
+ caption Caption value
+ disabled Disabled (no or yes)
+ end-time End time (e.g. 2008/12/31 11:59:59)
+ frequency Configure the report to automatically run daily.
+ period Time period to include in report (last 12 hrs, last 15 minutes, last 24 hrs, last 30 days, last 60 seconds, last 7 calendar
days, last 7 days, last calendar day, last calendar month, last calendar week, or last hour)
set reports
set reports
> aggregate-by Select from the list provided or specify a list of values enclosed in [ ]
> labels Label value or list of values enclosed in [ ]
> values Values (repeat count, or list of values enclosed in [ ])
Syntax
set rulebase or set vsys <name> rulebase
{
application-override rules <name> |
{
application <value> |
description <value> |
disabled {no | yes} |
negate-destination {no | yes} |
negate-source {no | yes} |
port <port_number> |
protocol {tcp | udp} |
destination {any | <value>} |
from {any | <value>} |
source {any | <value>} |
source-user {any | known-user | pre-logon | unknown | <value>} |
tag <value> |
to {any | multicast | <value>}
}
captive-portal rules <name> |
{
action {browser-challenge | no-captive-portal | web-form} |
description <value> |
disabled {no | yes} |
negate-destination {no | yes} |
negate-source {no | yes} |
category {any | <value>} |
destination {any | <value>} |
from {any | <value>} |
service {any | default | service-http | service-https | <value>} |
source {any | <value>} |
tag <value> |
to {any | <value>}
}
decryption rules <name> |
{
action {decrypt | no-decrypt} |
description <value> |
disabled {no | yes} |
negate-destination {no | yes} |
negate-source {no | yes} |
profile <name>
category {any | <value>} |
destination {any | <value>} |
to <value>
}
pbf rules <name> |
{
active-active-device-binding {0 | 1 | both} |
description <value> |
disabled {no | yes} |
negate-destination {no | yes} |
negate-source {no | yes} |
schedule <value> |
action |
{
forward |
{
egress-interface <value> |
monitor |
{
disable-if-unreachable {no | yes} |
ip-addresss <ip_address> |
profile {default | <value>}
}
nexthop <ip_address>
}
forward-to-vsys <value> |
discard |
no-pbf
}
application {any | <value>} |
destination {any | <value>} |
enforce-symmetric-return |
{
enabled {no | yes} |
nexthop-address-list <value>
}
from {interface <value> | zone <value>} |
service {any | application-default | service-http | service-https | <value>} |
source {any | <value>} |
source-user {any | known-user | pre-logon | unknown | <value>} |
tag <value>
}
qos rules <name> |
{
description <value> |
disabled {no | yes} |
negate-destination {no | yes} |
negate-source {no | yes} |
schedule <value> |
action {class {1 | 2 | 3 | 4 | 5 | 6 | 7 | 8}}
application <value> |
category {any | <value>} |
destination {any | <value>} |
from {any | <value>} |
service {any | application-default | service-http | service-https | <value>} |
source {any | <value>} |
Options
> application-override Application override rules
+ application Application (select from list of applications or enter a value)
+ description Description of rule set
+ service Service (any, predefined HTTP or HTTPS service, service name, or service group)
+ to-interface Egress interface from route lookup (any or interface name)
> destination Destination (any, IP address/network mask (x.x.x.x/y or IPv6/netmask), IP address range (x.x.x.x-y.y.y.y or
IPv6-range), value or list of values enclosed in [ ])
> destination-translation
+ translated-address IP address and network mask (x.x.x.x/y or IPv6/netmask), or IP address range (x.x.x.x-y.y.y.y or
IPv6-range)
+ translated-port Port number (1-65535)
> from From (any zone, value or list of values enclosed in [ ])
> source Source (any, IP address/network mask (x.x.x.x/y or IPv6/netmask), IP address range (x.x.x.x-y.y.y.y or IPv6range), value or list of values enclosed in [ ])
> source-translation
> dynamic-ip Dynamic IP-only translation
> fallback Fallback Dynamic IP and port translation
> interface-address Use interface address as translated address
+ interface Interface name
> floating-ip Floating IP address in HA Active-Active configuration
> ip Specify exact IP address if interface has multiple addresses
> translated-address IP address and network mask (x.x.x.x/y or IPv6/netmask), IP address range (x.x.x.xy.y.y.y or IPv6-range), value or list of values enclosed in [ ]
> translated-address IP address and network mask (x.x.x.x/y or IPv6/netmask), IP address range (x.x.x.x-y.y.y.y
or IPv6-range), value or list of values enclosed in [ ]
> dynamic-ip-and-port Dynamic IP and port translation
> interface-address Use interface address as translated address
+ interface Interface name
> floating-ip Floating IP address in HA Active-Active configuration
> ip Specify exact IP address if interface has multiple addresses
> translated-address IP address and network mask (x.x.x.x/y or IPv6/netmask), IP address range (x.x.x.x-y.y.y.y
or IPv6-range), value or list of values enclosed in [ ]
> static-ip Static IP translation via IP shifting
+ bi-directional Allow reverse translation from translated address to original address
+ translated-address IP address and network mask (x.x.x.x/y or IPv6/netmask), or IP address range (x.x.x.xy.y.y.y or IPv6-range)
> tag Tag (member value or list of values enclosed in [ ])
> to To (any zone, value or list of values enclosed in [ ])
> pbf Policy-based Forwarding (PBF) rules
+ active-active-device-binding Device binding configuration in High Availability (HA) Active-Active mode
0 Rule is bound to device 0
1 Rule is bound to device 1
both Rule is bound to both devices
+ description Description of rule set
+ disabled Disables the rule
+ negate-destination Negates destination
+ negate-source Negates source
+ schedule Schedule value
> action Policy-based forwarding action
> forward Forward packets
+ egress-interface Interface to route packet to
> monitor Parameters for monitoring
+ disable-if-unreachable Disable this rule if nexthop/monitor ip is unreachable
+ ip-address Monitor IP address (x.x.x.x or IPv6)
+ profile Monitoring profile associated with this rule
> nexthop Next hop IP address (x.x.x.x or IPv6)
> forward-to-vsys Virtual system/Shared gateway to route packets to
set schedule
set schedule
Specifies schedules for use in security policies. By default, each security policy applies to all dates and times. To
limit a security policy to specific dates and times, define a schedule and then apply it to the policy.
Syntax
set schedule <name>
{
non-recurring <value> |
recurring
{
daily <value> |
weekly {friday | monday | saturday | sunday | thursday | tuesday | wednesday}
<value>
}
}
Options
<name> Schedule to configure
+ non-recurring Non-recurring date-time range specification (YYYY/MM/DD@hh:mm-YYYY/MM/DD@hh:mm; e.g. 2006/
08/01@10:00-2007/12/31@23:59), or list of values enclosed in [ ]
> recurring Recurring period
+ daily Daily time range specification (hh:mm-hh:mm; e.g. 10:00-23:59), or list of values enclosed in [ ]
> weekly Week day and time range specification (hh:mm-hh:mm; e.g. 10:00-23:59), or list of values enclosed in [ ]
set service
set service
Configures protocol settings for services. When you define security policies for specific applications, you can specify
services to limit the port numbers the applications can use. Services requiring the same security settings can be
combined into service groups that you can refer to as a unit.
For information on configuring service groups using the CLI, refer to set service-group on page 233.
Syntax
set service <name>
{
description <value> |
protocol
{
tcp {port <port_number> | source-port <port_number>} |
udp {port <port_number> | source-port <port_number>}
}
tag <value>
}
Options
<name> Service to configure (up to 63 characters)
+ description Service description
> protocol Protocol service
> tcp Transmission Control Protocol (TCP)
+ port Port number or list of values enclosed in [ ] (1-65535)
+ source-port Source port number or list of values enclosed in [ ] (1-65535)
> udp User Datagram Protocol (UDP)
+ port Port number or list of values enclosed in [ ] (1-65535)
+ source-port Source port number or list of values enclosed in [ ] (1-65535)
> tag Tag name
set service-group
set service-group
Configures sets of services that will be assigned the same security settings, to simplify the creation of security
policies. When you define security policies for specific applications, you can specify one or more services or service
groups to limit the port numbers the applications can use.
For information on configuring services using the CLI, refer to set service on page 232.
Syntax
set service-group <name> {service-http | service-https | <value>} {tag <value>}
Options
<name> Service group name to configure (up to 63 characters)
<value> HTTP, HTTPS, member value or list of values enclosed in [ ]
tag Tag name
set setting
set setting
Configures Network Address Translation (NAT) and SSL decryption settings for interaction with other services on
the firewall.
Syntax
set setting
{
nat |
{
reserve-ip {no | yes} |
reserve-time <value>
}
ssl-decrypt
{
allow-forward-decrypted-content {no | yes} |
answer-timeout <value> |
notify-user {no | yes} |
url-proxy {no | yes}
}
}
Options
> nat Network Address Translation (NAT)
+ reserve-ip Reserve translated IP for specified time
+ reserve-time Reserve time value in seconds (1-604800)
> ssl-decrypt Secure Socket Layer (SSL) decryption
+ allow-forward-decrypted-content Allow forwarding of decrypted content. For example, this setting will determine
whether files from decrypted sessions can be sent to WildFire for analysis.
+ answer-timeout Set user reply timeout value in seconds (1-86400)
+ notify-user Set if user notification should be enabled
+ url-proxy Set proxy for SSL sessions if IP's URL category is blocked
Syntax
set shared admin-role <name>
{
description <value> |
role
{
device
{
cli {deviceadmin | devicereader | superreader | superuser} |
webui
{
acc {disable | enable} |
commit {disable | enable} |
dashboard {disable | enable} |
device |
{
access-domain {disable | enable | read-only} |
admin-roles {disable | enable | read-only} |
administrators {disable | enable | read-only} |
authentication-profile {disable | enable | read-only} |
authentication-sequence {disable | enable | read-only} |
block-pages {disable | enable | read-only} |
config-audit {disable | enable} |
dynamic-updates {disable | enable | read-only} |
global-protect-client {disable | enable | read-only} |
high-availability {disable | enable | read-only} |
licenses {disable | enable | read-only} |
master-key {disable | enable | read-only} |
password-profiles {disable | enable | read-only} |
scheduled-log-export {disable | enable} |
setup {disable | enable | read-only} |
shared-gateways {disable | enable | read-only} |
software {disable | enable | read-only} |
support {disable | enable | read-only} |
user-identification {disable | enable | read-only} |
virtual-systems {disable | enable | read-only} |
certificate-management |
certificate-profile {disable | enable | read-only} |
certificates {disable | enable | read-only} |
ocsp-responder {disable | enable | read-only}
}
local-user-database |
{
user-groups {disable | enable | read-only} |
users {disable | enable | read-only} |
}
log-settings |
{
cc-alarm {disable | enable | read-only} |
config {disable | enable | read-only} |
hipmatch {disable | enable | read-only} |
manage-log {disable | enable | read-only} |
system {disable | enable | read-only}
}
server-profile
{
email {disable | enable | read-only} |
kerberos {disable | enable | read-only} |
ldap {disable | enable | read-only} |
netflow {disable | enable | read-only} |
radius {disable | enable | read-only} |
snmp-trap {disable | enable | read-only} |
syslog {disable | enable | read-only}
}
}
global system-alarms {disable | enable} |
monitor |
{
app-scope {disable | enable} |
application-reports {disable | enable} |
botnet {disable | enable | read-only} |
packet-capture {disable | enable | read-only} |
session-browser {disable | enable} |
threat-reports {disable | enable} |
traffic-reports {disable | enable} |
url-filtering-reports {disable | enable} |
view-custom-reports {disable | enable} |
custom-reports |
{
application-statistics {disable | enable} |
data-filtering-log {disable | enable} |
hipmatch {disable | enable} |
threat-log {disable | enable} |
threat-summary {disable | enable} |
traffic-log {disable | enable} |
traffic-summary {disable | enable} |
url-log {disable | enable}
}
logs |
{
alarm {disable | enable} |
configuration {disable | enable} |
data-filtering {disable | enable} |
hipmatch {disable | enable} |
system {disable | enable} |
threat {disable | enable} |
traffic {disable | enable} |
url {disable | enable} |
wildfire {disable | enable}
}
pdf-reports
{
email-scheduler {disable | enable | read-only} |
manage-pdf-summary {disable | enable | read-only} |
pdf-summary-reports {disable | enable} |
report-groups {disable | enable | read-only} |
user-activity-report {disable | enable | read-only} |
}
}
network |
dhcp {disable | enable | read-only} |
dns-proxy {disable | enable | read-only} |
interfaces {disable | enable | read-only} |
ipsec-tunnels {disable | enable | read-only} |
qos {disable | enable | read-only} |
virtual-routers {disable | enable | read-only} |
virtual-wires {disable | enable | read-only} |
vlans {disable | enable | read-only} |
zones {disable | enable | read-only} |
global-protect |
{
gateways {disable | enable | read-only} |
portals {disable | enable | read-only}
}
network-profiles
{
ike-crypto {disable | enable | read-only} |
ike-gateways {disable | enable | read-only} |
interface-mgmt {disable | enable | read-only} |
ipsec-crypto {disable | enable | read-only} |
qos-profile {disable | enable | read-only} |
tunnel-monitor {disable | enable | read-only} |
zone-protection {disable | enable | read-only}
}
}
objects |
{
address-groups {disable | enable | read-only} |
addresses {disable | enable | read-only} |
application-filters {disable | enable | read-only} |
application-groups {disable | enable | read-only} |
applications {disable | enable | read-only} |
custom-url-category {disable | enable | read-only} |
decryption-profile {disable | enable | read-only} |
dynamic-block-lists {disable | enable | read-only} |
log-forwarding {disable | enable | read-only} |
regions {disable | enable | read-only} |
schedules {disable | enable | read-only} |
security-profile-groups {disable | enable | read-only} |
service-groups {disable | enable | read-only} |
services {disable | enable | read-only} |
custom-signatures |
{
data-patterns {disable | enable | read-only} |
spyware {disable | enable | read-only} |
Options
<name> Shared administrative role name
+ description Description text
> role Sets access and responsibilities for the role
> device Device settings
+ cli Command Line Interface access
- deviceadmin Device Administrator
- devicereader Device Reader
- superreader Super Reader
- superuser Super User
> webui Sets enable, disable, or read-only access to the web user interface
+ acc Access
+ commit Commit
+ dashboard Dashboard
> device Device settings
+ access-domain Access domain
+ admin-roles Admin roles
+ administrators Administrators
+ authentication-profile Authentication profile
+ authentication-sequence Authentication sequence
+ block-pages Block pages
+ config-audit Configuration audit
+ dynamic-updates Dynamic updates
+ global-protect-client GlobalProtect Client
+ high-availability High Availability
+ licenses Licenses
+ master-key Disable, enable, or read-only device master key
+ password-profiles Password profiles
+ scheduled-log-export Scheduled log export
+ setup Setup
+ shared-gateways Shared gateways
+ software Software
+ support Support
+ user-identification User identification
+ virtual-systems Virtual systems
> certificate-management Certificate management
+ certificate-profile Certificate profile
+ certificates Certificates
+ ocsp-responder OCSP responder
> local-user-database Local user database
+ user-groups User groups
+ users Users
> log-settings Log settings
+ cc-alarm Disable, enable, or read-only the CC alarm log
+ config Disable, enable, or read-only the configuration log
+ hipmatch Disable, enable, or read-only the hipmatch log
+ manage-log Disable, enable, or read-only management log
+ system Disable, enable, or read-only the system log
> server-profile Server profile
+ email Email profile
+ kerberos Kerberos profile
+ ldap LDAP profile
+ netflow NetFlow profile
+ radius RADIUS profile
+ snmp-trap SNMP trap profile
+ syslog syslog profile
> global Global settings
+ system-alarms Global system alarm settings
> monitor Monitor settings
+ app-scope Application scope
+ application-reports Application reports
+ botnet Botnet
+ packet-capture Packet capture
+ session-browser Session browser
+ threat-reports Threat reports
+ traffic-reports Traffic reports
+ url-filtering-reports URL filtering reports
+ zones Zones
> global-protect GlobalProtect settings
+ gateways Gateways
+ portals Portals
> objects Objects settings
+ address-groups Address groups
+ addresses Addresses
+ application-filters Application filters
+ application-groups Application groups
+ applications Applications
+ custom-url-category Custom URL category
+ decryption-profile Decryption profile
+ dynamic-block-lists Dynamic block lists
+ log-forwarding Log forwarding
+ regions Regions
+ schedules Schedules
+ security-profile-groups Security profile groups
+ service-groups Service groups
+ services Services
> custom-signatures Custom signatures
+ data-patterns Data patterns
+ spyware Spyware
+ vulnerability Vulnerability
> global-protect GlobalProtect settings
+ hip-objects Host IP objects
+ hip-profiles Host IP profiles
> security-profiles Security profile settings
+ anti-spyware Anti-spyware
+ antivirus Antivirus
+ data-filtering Data filtering
+ dos-protection DOS protection
+ file-blocking file blocking
+ url-filtering URL filtering
+ vulnerability-protection Vulnerability protection
> policies Policy settings
+ application-override-rulebase Application override rulebase
+ captive-portal-rulebase Captive portal rulebase
+ dos-rulebase DOS rulebase
+ nat-rulebase NAT rulebase
+ pbf-rulebase PBF rulebase
+ qos-rulebase QOS rulebase
+ security-rulebase Security rulebase
+ ssl-decryption-rulebase SSL decryption rulebase
> privacy Privacy settings
+ show-full-ip-addresses Show full IP addresses
+ show-user-names-in-logs-and-reports Show user names in logs and reports
+ view-pcap-files View packet capture files
> xmlapi Sets enable or disable access to the XML API user interface
+ commit Commit
+ config Configuration
+ export Export
+ import Import
+ log Log
+ op Operation
+ report Report
+ user-id User ID
Syntax
set shared alg-override application <name>
{
alg-disabled {no | yes}
}
Options
> application Specify application name
+ alg-disabled Specify whether SIP ALG is disabled (yes) or disabled (no)
Sample Output
The following command disables SIP ALG.
username@hostname# set shared alg-override application sip alg-disabled yes
no
[edit]
username@hostname#
Syntax
set shared authentication-profile <group_name> |
{
allow-list {all | <value>} |
lockout |
{
failed-attempts <value> |
lockout-time <minutes>
}
method
{
kerberos {server-profile <object_name>} |
ldap |
{
login-attribute <value> |
passwd-exp-days <value> |
server-profile <name>
}
radius {server-profile <object_name>}
local-database |
none
}
}
Options
<group_name> Specify group to share the profile
+ allow-list List of allowed users and groups enclosed in [ ]; option to specify all
> lockout Network user login lockout settings
+ failed-attempts Number of failed login attempts to trigger lock-out
+ lockout-time Number of minutes to lock-out
> method method
> kerberos Kerberos authentication
+ server-profile Kerberos server profile object
> ldap Lightweight Directory Access Protocol (LDAP) authentication
+ login-attribute Login attribute in LDAP server to authenticate against; default = uid
+ passwd-exp-days Days until the password expires
+ server-profile LDAP server profile object
> radius Remote Authentication Dial In User Service (RADIUS) authentication
+ server-profile RADIUS server profile object
- local-database Local database authentication
- none No authentication
Syntax
set shared authentication-sequence <name>
{
authentication-profiles <value> |
lockout
{
failed-attempts <value> |
lockout-time <value>
}
}
Options
<name> Authentication sequence name
+ authentication-profiles Authentication profiles to apply in the sequence (name or list of names enclosed in [ ])
> lockout Network user login lockout settings
+ failed-attempts Number of failed login attempts to trigger lock-out (0-10)
+ lockout-time Number of minutes to lock-out (0-60)
Syntax
set shared botnet
{
configuration |
{
http |
{
dynamic-dns {enabled {no | yes} | threshold <value>} |
executables-from-unknown-sites {enabled {no | yes} | threshold <value>} |
ip-domains {enabled {no | yes} | threshold <value>} |
malware-sites {enabled {no | yes} | threshold <value>} |
recent-domains {enabled {no | yes} | threshold <value>}
}
other-applications irc {no | yes} |
unknown-application {unknown-tcp | unknown-udp}
{
destinations-per-hour <value> |
sessions-per-hour <value> |
session-length {maximum-bytes <value> | minimum-bytes <value>}
}
}
report
{
query <value> |
scheduled {no | yes} |
topn <value>
}
}
Options
> configuration Botnet configuration
> http HTTP configuration
> dynamic-dns Dynamic DNS
+ enabled Enabled (no or yes)
+ threshold Repeat dynamic DNS sites visit threshold (2-1000)
> executables-from-unknown-sites executables-from-unknown-sites
+ enabled Enabled (no or yes)
+ threshold Repeat executables download from unknown sites visit threshold (2-1000)
> ip-domains IP domains
+ enabled Enabled (no or yes)
+ threshold Repeat IP domains visit threshold (2-1000)
> malware-sites Malware sites
+ enabled Enabled (no or yes)
+ threshold Repeat malware sites visit threshold (2-1000)
Syntax
set shared certificate <name> |
{
common-name <value> |
expiry-epoch <value> |
issuer <value> |
issuer-hash <value> |
not-valid-after <value> |
not-valid-before <value> |
private-key <value> |
revoke-date-epoch <value> |
status {revoked | valid} |
subject <value> |
subject-hash <value> |
csr <value> |
public-key <value>
}
Options
<name> Shared certificate name
+ common-name Common name value
+ expiry-epoch Expiry epoch value
+ issuer Issuer value
+ issuer-hash Issuer-hash value
+ not-valid-after Not-valid-after value
+ not-valid-before Not-valid-before value
+ private-key Private key value
+ revoke-date-epoch Revoke date epoch value
+ status Status (revoked or valid)
+ subject Subject value
+ subject-hash Subject-hash value
> csr Certificate Signing Request (CSR) value
> public-key Public key value
Syntax
set shared certificate-profile <name> |
{
block-timeout-cert {no | yes} |
block-unknown-cert {no | yes} |
cert-status-timeout <value> |
crl-receive-timeout <value> |
domain <name> |
ocsp-receive-timeout <value> |
use-crl {no | yes} |
use-ocsp {no | yes} |
CA <name> |
{
default-ocsp-url <value> |
ocsp-verify-ca <value>
}
username-field
{
subject common-name |
subject-alt {email | principal-name}
}
}
Options
<name> Profile name
+ block-timeout-cert Whether to block a session if certificate status can't be retrieved within timeout
+ block-unknown-cert Whether to block a session if certificate status is unknown
+ cert-status-timeout Set certificate status query timeout value in seconds (0-60)
+ crl-receive-timeout Set CRL receive timeout value in seconds (0-60)
+ domain Domain name (alphanumeric string [ 0-9a-zA-Z._-])
+ ocsp-receive-timeout Set OCSP receive timeout value in seconds (0-60)
+ use-crl Use Certificate Revocation List (CRL)
+ use-ocsp Use Online Certificate Status Protocol (OCSP)
> CA Certificate Authority (CA) name
+ default-ocsp-url Default URL for OCSP verification
+ ocsp-verify-ca CA file for OCSP response verify
> username-field User name field population
> subject Get user name from subject
> subject-alt Get user name from subject alternative name (email or principal name)
Syntax
set shared email-scheduler <name>
{
email-profile <value> |
recipient-emails <value> |
report-group <value> |
recurring
{
weekly {friday | monday | saturday | sunday | thursday | tuesday | wednesday} |
daily |
disabled
}
}
Options
<name> Specifies the name for the email scheduler
+ email-profile Email profile value
+ recipient-emails Recipient emails value
+ report-group Report group value
> recurring Recurring frequency
> weekly Once a week; specify the day
- daily Every day
- disabled No scheduling
Syntax
set shared local-user-database
{
user <name> |
{
disabled {no | yes} |
phash <value>
}
user-group <name> {user <value>}
}
Options
> user User name
+ disabled Disabled (no or yes)
+ phash phash value
> user-group User group name
> user User name or list of names enclosed in [ ]
Syntax
set shared log-settings
{
config |
{
any
{
send-to-panorama {no | yes} |
send-email using-email-setting <value> |
send-snmptrap using-snmptrap-setting <value> |
send-syslog using-syslog-setting <value>
}
}
email <name> |
{
format |
{
config <value> |
hip-match <value> |
system <value> |
threat <value> |
traffic <value> |
escaping {escape-character <value> | escaped-characters <value>}
}
server <name>
{
and-also-to <value> |
display-name <name> |
from <value> |
gateway <value> |
to <value>
}
}
hipmatch |
{
any
{
send-to-panorama {no | yes} |
send-email using-email-setting <value> |
send-snmptrap using-snmptrap-setting <value> |
send-syslog using-syslog-setting <value>
}
}
profiles <name> |
{
alarm {critical | high | informational | low | medium} |
{
medium}
medium}
Options
> config Configuration log settings (any)
+ send-to-panorama Send to Panorama (no or yes)
> send-email Send email using email setting value
> send-snmptrap Send SNMP trap using SNMP trap setting value
> send-syslog Send syslog using syslog setting value
> email Email log settings name
> format Custom formats for forwarded logs
+ config Config value
+ hip-match HIP match value
+ system System value
+ threat Threat value
+ traffic Traffic value
> escaping Escaping values
+ escape-character Escape character
+ escaped-characters List of characters to be escaped
> server Server address
+ and-also-to Email address (e.g. [email protected])
+ display-name Display name of server
+ from Email address (e.g. [email protected])
+ gateway IP address or FQDN of SMTP gateway to use
+ to Email address (e.g. [email protected])
Syntax
set shared override
{
application <name>
{
risk <value> |
tcp-half-closed-timeout <value> |
tcp-time-wait-timeout <value> |
tcp-timeout |
timeout <value> |
udp-timeout <value>
}
}
Options
> application Select from the list or enter a name
+ risk Risk (1-5)
+ tcp-half-closed-timeout Timeout of the TCP session after the first FIN is seen by the firewall. Value is in seconds (0604800). The default value is the value set at the global level.
+ tcp-time-wait-timeout Timeout of the TCP session after the second FIN or a RST is seen by the firewall. Value is in
seconds (0-600). The default value is the value set at the global level.
+ tcp-timeout Timeout in seconds (0-604800) before an idle TCP application flow is terminated.
+ timeout Timeout in seconds (0-604800) before an idle application flow is terminated. A setting of 0 indicates that the
default timeout of the application will be used. This timer is for protocols other than TCP and UDP.
+ udp-timeout Timeout in seconds (0-604800) before an idle UDP application flow is terminated. A setting of 0 indicates
that the default timeout of the application will be used.
Syntax
set shared pdf-summary-report <name>
{
custom-widget <name> |
{
chart-type {bar | line | pie | table} |
column <value> |
row <value>
}
footer {note <value>} |
header {caption <value>}|
predefined-widget <name> |
{
chart-type {bar | line | pie | table} |
column <value> |
row <value>
}
}
Options
<name> PDF report to configure
> custom-widget Report widget layout information
+ chart-type Chart type (bar, line, pie, or table)
+ column Column number (1-3)
+ row Row number (1-6)
> footer Footer information for PDF summary layout
+ note Static string to be printed as a note
> header Header information for PDF summary layout
+ caption Caption for the layout
> predefined-widget Predefined report widget layout information
+ chart-type Chart type (bar, line, pie, or table)
+ column Column number (1-3)
+ row Row number (1-6)
Syntax
set shared post-rulebase [refer to set rulebase or set vsys rulebase on page 220]
{
application-override rules <name> |
captive-portal rules <name> |
decryption rules <name> |
default-security-rules rules {intrazone-default | interzone-default}|
dos rules <name> |
nat rules <name> |
pbf rules <name> |
qos rules <name> |
security rules <name>
}
Required Configuration
The following command configures device group objects so that they cannot override corresponding objects of the
same name from a shared location.
username@hostname> set deviceconfig setting management shared-objects-take-precedence
yes
username@hostname>
Syntax
set shared pre-rulebase [refer to set rulebase or set vsys rulebase on page 220]
{
application-override rules <name> |
captive-portal rules <name> |
decryption rules <name> |
dos rules <name> |
nat rules <name> |
pbf rules <name> |
qos rules <name> |
security rules <name>
}
Required Configuration
The following command configures device group objects so that they cannot override corresponding objects of the
same name from a shared location.
username@hostname> set deviceconfig setting management shared-objects-take-precedence
yes
username@hostname>
Syntax
set shared report-group <name> |
{
title-page {no | yes} |
custom-widget <value> |
{
custom-report <value> |
log-view <value> |
pdf-summary-report <value>
predefined-report <value>
}
predefined user-activity-report |
variable <name> {value <value>}
}
Options
<name> Report group to configure
+ title-page Include title page
> custom-widget Custom-widget value
> custom-report Custom report value
> log-view Log view value
> pdf-summary-report PDF summary report value
> predefined-report Predefined report value
> predefined Predefined user activity report
> variable Variable name; option to include a value
Syntax
set shared reports <name>
{
caption <value> |
disabled {no | yes} |
end-time <value> |
frequency daily |
period {last-12-hrs | last-15-minutes | last-24-hrs | last-30-days | last-60-seconds
| last-7-calendar-days | last-7-days | last-calendar-day | last-calendar-month |
last-calendar-week | last-hour} |
query <value> |
start-time <value> |
topm <value> |
topn <value> |
type
{
appstat |
{
group-by {category-of-name | container-of-name | day-of-receive_time | hourof-receive_time | name | quarter-hour-of-receive_time | risk | risk-of-name
| subcategory-of-name | technology-of-name | vsys} |
sortby {nbytes | npkts | nsess | nthreats} |
aggregate-by {category-of-name | container-of-name | day-of-receive_time |
hour-of-receive_time | name | quarter-hour-of-receive_time | risk | riskof-name | subcategory-of-name | technology-of-name | vsys | <value>} |
labels <value> |
values {nbytes | npkts | nsess | nthreats | <value>}
}
data |
{
group-by {action | app | category-of-app | container-of-app | day-ofreceive_time | direction | dport | dst | dstloc | dstuser | from | hour-ofreceive_time | inbound_if | misc | natdport | natdst | natsport | natsrc |
outbound_if | proto | quarter-hour-of-receive_time | risk-of-app | rule |
severity | sport | src | srcloc | srcuser | subcategory-of-app | subtype |
technology-of-app | threatid | to | vsys} |
sortby repeatcnt |
aggregate-by {action | app | category-of-app | container-of-app | day-ofreceive_time | direction | dport | dst | dstloc | dstuser | from | hour-ofreceive_time | inbound_if | misc | natdport | natdst | natsport | natsrc |
outbound_if | proto | quarter-hour-of-receive_time | risk-of-app | rule |
severity | sport | src | srcloc | srcuser | subcategory-of-app | subtype |
technology-of-app | threatid | to | vsys | <value>} |
labels <value> |
values {repeatcnt | <value>}
}
hipmatch |
{
group-by {day-of-receive_time | hour-of-receive_time | machinename | matchname
| matchtype | quarter-hour-of-receive_time | src | srcuser | vsys} |
last-match-by time_generated |
aggregate-by {day-of-receive_time | hour-of-receive_time | machinename |
matchname | matchtype | quarter-hour-of-receive_time | src | srcuser | vsys
| <value>} |
labels <value> |
values {repeatcnt | <value>}
}
threat |
{
group-by {action | app | category-of-app | container-of-app | day-ofreceive_time | direction | dport | dst | dstloc | dstuser | from | hour-ofreceive_time | inbound_if | misc | natdport | natdst | natsport | natsrc |
outbound_if | proto | quarter-hour-of-receive_time | risk-of-app | rule |
severity | sport | src | srcloc | srcuser | subcategory-of-app | subtype |
technology-of-app | threatid | to | vsys} |
sortby repeatcnt |
aggregate-by {action | app | category-of-app | container-of-app | day-ofreceive_time | direction | dport | dst | dstloc | dstuser | from | hour-ofreceive_time | inbound_if | misc | natdport | natdst | natsport | natsrc |
outbound_if | proto | quarter-hour-of-receive_time | risk-of-app | rule |
severity | sport | src | srcloc | srcuser | subcategory-of-app | subtype |
technology-of-app | threatid | to | vsys | <value>} |
labels <value> |
values {repeatcnt | <value>}
}
thsum |
{
group-by {app | category-of-app | container-of-app | day-of-receive_time | dst
| dstloc | dstuser | from | hour-of-receive_time | quarter-hour-ofreceive_time | risk-of-app | rule | severity-of-threatid | src | srcloc |
srcuser | subcategory-of-app | subtype | technology-of-app | threatid | to
| vsys} |
sortby count |
aggregate-by {app | category-of-app | container-of-app | day-of-receive_time |
dst | dstloc | dstuser | from | hour-of-receive_time | quarter-hour-ofreceive_time | risk-of-app | rule | severity-of-threatid | src | srcloc |
srcuser | subcategory-of-app | subtype | technology-of-app | threatid | to
| vsys | <value>} |
labels <value> |
values {count | <value>}
}
traffic |
{
group-by {action | app | category | category-of-app | container-of-app | dayof-receive_time | dport | dst | dstloc | dstuser | from | hour-ofreceive_time | inbound_if | natdport | natdst | natsport | natsrc |
outbound_if | proto | quarter-hour-of-receive_time | risk-of-app | rule |
sessionid | sport | src | srcloc | srcuser | subcategory-of-app |
technology-of-app | to | vsys} |
sortby {bytes | bytes_received | bytes_sent | elapsed | packets |
ptks_received | pkts_sent | repeatcnt} |
Options
<name> Report to configure
+ caption Caption value
+ disabled Disabled (no or yes)
+ end-time End time (e.g. 2008/12/31 11:59:59)
+ frequency Configure the report to automatically run daily.
+ period Time period to include in report (last 12 hrs, last 15 minutes, last 24 hrs, last 30 days, last 60 seconds, last 7 calendar
days, last 7 days, last calendar day, last calendar month, last calendar week, or last hour)
> aggregate-by Select from the list provided or specify a list of values enclosed in [ ]
> labels Label value or list of values enclosed in [ ]
> values Values (repeat count, or list of values enclosed in [ ])
Syntax
set shared response-page
{
application-block-page <value> |
captive-portal-text <value> |
file-block-continue-page <value> |
file-block-page <value> |
ssl-cert-status-page <value> |
ssl-optout-text <value> |
url-block-page <value> |
url-coach-text <value> |
virus-block-page <value> |
global-protect-portal-custom-help-page <name> {page <value>} |
global-protect-portal-custom-login-page <name> {page <value>} |
global-protect-portal-custom-welcome-page <name> {page <value>} |
}
Options
+ application-block-page Application block page value
+ captive-portal-text Captive portal text value
+ file-block-continue-page File block continue page value
+ file-block-page File block page value
+ ssl-cert-status-page SSL certificate status page value
+ ssl-optout-text SSL optout text value
+ url-block-page URL block page value
+ url-coach-text URL coach text value
+ virus-block-page Virus block page value
> global-protect-portal-custom-help-page GlobalProtect portal custom help page name
+ page GlobalProtect portal custom help page value
> global-protect-portal-custom-login-page GlobalProtect portal custom login page name
+ page GlobalProtect portal custom login page value
> global-protect-portal-custom-welcome-page GlobalProtect portal custom welcome page name
+ page GlobalProtect portal custom welcome page value
Syntax
set shared server-profile
{
kerberos <name> |
{
admin-use-only {no | yes} |
domain <name> |
realm <name> |
server <name> {host <value> | port <value>}
}
ldap <name> |
{
admin-use-only {no | yes} |
base <value> |
bind-dn <value> |
bind-password <value> |
bind-timelimit <value> |
disabled {no | yes} |
domain <name> |
ldap-type {active-directory | e-directory | none | sun} |
retry-interval <value> |
ssl {no | yes} |
timelimit <value> |
server <name> {address <value> | port <value>}
}
netflow <name> |
{
active-timeout {value} |
export-enterprise-fields {no | yes} |
server <name> {host {{<ip address/netmask> | <address object>} | <value>} | port
<value>} |
template-refresh-rate {minutes <value> | packets <value>}
}
radius <name>
{
admin-use-only {no | yes} |
checkgroup {no | yes} |
domain <name> |
retries <value> |
timeout <value> |
server <name> {ip-address <ip_address> | port <value> | secret <value>}
}
}
Options
> kerberos Kerberos profile name
Syntax
set shared ssl-decrypt
{
forward-trust-certificate <value> |
forward-untrust-certificate <value> |
root-ca-exclude-list <value> |
ssl-exclude-cert <value> |
trusted-root-CA <value>
}
Options
+ forward-trust-certificate CA certificate for trusted sites
+ forward-untrust-certificate CA certificate for untrusted sites
> root-ca-exclude-list List of predefined root CAs to not trust
> ssl-exclude-cert SSL exclude certificate (member value or list of values enclosed in [ ])
> trusted-root-CA Trusted root CA (member value or list of values enclosed in [ ])
set template
set template
(Panorama only) Configures templates to manage and deploy configurations to multiple devices that require similar settings.
For more information, refer to the Panorama Administrators Guide.
Syntax
set template <name>
{
description <value> |
config | [for available configurations, refer to the separate command pages in this chapter]
{
deviceconfig |
mgt-config |
network |
shared |
vsys
}
devices <value> |
settings
multi-vsys {no | yes} |
operational-mode {cc | fips | normal} |
vpn-disable-mode {no | yes}
}
Options
<name> Specifies template to configure
+ description Template description text
> config Configurations that can be included in the template
> deviceconfig Device configurations [refer to separate command pages in this chapter]
> mgt-config Management configurations [refer to separate command pages in this chapter]
> network Network configuration [refer to separate command pages in this chapter]
> shared Shared configurations [refer to separate command pages in this chapter]
> vsys Virtual system configurations [refer to separate command pages in this chapter]
> devices Device serial numbers
> settings Template settings
+ multi-vsys Multiple virtual systems (no or yes)
+ operational-mode Operational mode (Common Criteria, FIPS, or Normal)
+ vpn-disable-mode VPN disable mode (no or yes)
set threats
set threats
Specifies settings for threat definitions. Palo Alto Networks periodically posts updates with new or revised
application definitions and information on new security threats, such as antivirus signatures (threat prevention license
required). To upgrade the firewall, you can view the latest updates, read the release notes for each update, and then
select the update you want to download and install.
Syntax
set threats
{
spyware <threat_id> |
{
comment <value> |
direction <value> |
severity <value> |
threatname <name> |
bugtraq <value> |
cve <value> |
default-action |
{
alert |
block-ip |
{
duration <value> |
track-by {source | source-and-destination}
}
drop-packets |
reset-both |
reset-client |
reset-server
}
reference <value> |
signature |
{
combination |
{
order-free {no | yes} |
and-condition <name> {or-condition <name>} {threat-id <threat_id>} |
time-attribute
{
interval <value> |
threshold <value> |
track-by {destination | source | source-and-desintation}
}
}
standard <name>
{
comment <value> |
order-free {no | yes} |
scope {protocol-data-unit | session} |
and-condition <name> {or-condition <name>}
set threats
{
operator {equal-to | greater-than | less-than} |
{
context <value> |
value <value> |
qualifier <name> {value <value>}
}
operator pattern-match
{
context <value> |
pattern <value> |
qualifier <name> {value <value>}
}
}
}
}
vendor <value>
}
vulnerability <value>
{
comment <value> |
direction {both | client2server | server2client} |
severity {critical | high | informational | low | medium} |
threatname <name> |
affected-host {client | server} {no | yes} |
bugtraq <value> |
cve <value> |
default-action |
{
alert |
block-ip |
{
duration <value> |
track-by {source | source-and-desintation}
}
drop-packets |
reset-both |
reset-client |
reset-server
}
reference <value> |
signature |
{
combination |
{
order-free {no | yes} |
and-condition <name> {or-condition <name>} {threat-id <threat_id>} |
time-attribute
{
interval <value> |
threshold <value> |
track-by {destination | source | source-and-desintation}
}
}
set threats
standard <name>
{
comment <value> |
order-free {no | yes} |
scope {protocol-data-unit | session} |
and-condition <name> {or-condition <name>}
{
operator {equal-to | greater-than | less-than} |
{
context <value> |
value <value> |
qualifier <name> {value <value>}
}
operator pattern-match
{
context <value> |
pattern <value> |
qualifier <name> {value <value>}
}
}
}
}
vendor <value>
}
}
Options
> spyware Spyware threat ID (15000-18000)
+ comment Spyware threat ID comment
+ direction Direction value
+ severity Severity value
+ threatname Threat name (alphanumeric string [ 0-9a-zA-Z._-])
> bugtraq Bugtraq ID value or list of values enclosed in [ ]
> cve Common Vulnerabilities and Exposures (CVE) number (e.g., CVE-1999-0001) or list of values enclosed in [ ]
> default-action Default action (block IP address, alert, drop packets, reset client, reset server, or reset both)
> block-ip Block IP address
+ duration Duration for block IP address (1-3600)
+ track-by Track by source or source and destination
> reference Reference URL or list of values enclosed in [ ]
> signature Spyware signature
> combination Combination signature
+ order-free Order free (no or yes)
> and-condition And-condition name
> or-condition Or-condition name
+ threat-id Threat ID value
> time-attribute Time attribute options
+ interval Interval value (1-3600)
+ threshold Threshold value (1-255)
+ track-by Track by destination, source, or source and destination
> standard Standard signature
+ comment Signature comment
+ order-free Order free (no or yes)
+ scope Protocol data unit transaction or session
set threats
set ts-agent
set ts-agent
Configures a terminal server (TS) agent on the firewall. The TS agent runs on a terminal server and identifies
individual users that the terminal server supports. This arrangement allows the firewall to support multiple users with
the same source IP address. The TS agent monitors the remote user sessions and reserves a different TCP/UDP source
port range for each user session. After a port range is allocated for the user session, the TS agent provides information
to map the source port range to the user name.
Syntax
set ts-agent <name>
{
disable {no | yes} |
host {{<ip address/netmask> | <address object>} | <value>} |
port <port_number> |
ip-list <value>
}
Options
<name> Specifies the terminal server agent to configure
+ disabled Terminal server agent disabled (no or yes)
+ host IP address and network mask or hostname for agent
+ port Terminal server agent listening port number (1-65535)
> ip-list Terminal server alternative IP address list (x.x.x.x or IPv6 or list of values enclosed in [ ]))
set url-admin-override
set url-admin-override
Configures URL administrative override settings that are used when a page is blocked by the URL filtering profile
and the Override action is specified.
Syntax
set user-admin-override
{
password <value> |
server-certificate <value> |
mode
{
redirect address {<host_name> | {<ip address/netmask> | <address object>}} |
transparent
}
}
Options
+ password Password for URL administrative override
+ server-certificate SSL server certificate file name
> mode Override mode
> redirect Redirect mode
+ address Set IP address or host name for URL administrative override
transparent Transparent mode
set url-content-types
set url-content-types
Defines the HTML content types that will be available for custom pages and other services.
Syntax
set url-content-types <value>
Options
+ url-content-types Content type string or list of values enclosed in [ ]
- application/pdf Default URL content type: application/PDF
- application/soap+xml Default URL content type: application/SOAP+XML
- application/xhtml+xml Default URL content type: application/XHTML+XML
- text/html Default URL content type: text/HTML
- text/plain Default URL content type: text/plain
- text/xml Default URL content type: text/XML
set user-id-agent
set user-id-agent
Configures a User Identification Agent (User-ID Agent). A User-ID Agent is a Palo Alto Networks application that is
installed on your network to obtain needed mapping information between IP addresses and network users. The UserID Agent collects user-to-IP address mapping information automatically and provides it to the firewall for use in
security policies and logging.
Syntax
set user-id-agent <name>
{
collectorname <value> |
disabled {no | yes} |
host {{<ip address/netmask> | <address object>} | <value>} |
ldap-proxy {no | yes} |
ntlm-auth {no | yes} |
port <port_number> |
secret <value>
}
Options
<name> Specifies the User-ID agent to configure
+ collectorname Collector name on peer PAN OS
+ disabled Disabled (no or yes)
+ host IP address and network mask or hostname for User-ID agent
+ ldap-proxy LDAP proxy
+ ntlm-auth NTLM authentication
+ port PAN User-ID agent listening port (1-65535; default = 5007)
+ secret Collector pre-shared key on peer PAN OS
set user-id-agent-sequence
set user-id-agent-sequence
Determines the order in which to use the configured User Identification Agents. To configure a User ID Agent, refer
to set user-id-agent on page 285.
Syntax
set user-id-agent-sequence user-id-agents <name>
Options
<name> List of user-ID agent name or list of names enclosed in [ ]
set user-id-collector
set user-id-collector
Configures a User Identification Collector. Specifies settings to use the PAN-OS User Mapping feature to provide
accurate mappings between IP addresses and logged-in users, as well as user-to-group membership mapping. This
option performs the same functions as the User-ID Agent but directly from the firewall, so no agent is required on the
domain controllers.
For more information, refer to the User-ID section in the PAN-OS Administrators Guide.
Syntax
set user-id-collector <name>
{
directory-server <name> |
{
disabled {no | yes} |
host <value> |
server-profile <name> |
type {active-directory | e-directory | exchange}
}
ignore-user <value> |
include-exclude-network <name> |
{
disabled {no | yes} |
discovery {exclude | include} |
network-address {<ip address/netmask> | <address object>}
}
include-exclude-network-sequence include-exclude-network <name> |
server-monitor <name> |
{
description <value> |
disabled {no | yes} |
active-directory host {<ip address/netmask> | <address object>} |
e-directory server-profile <value> |
exchange host {<ip address/netmask> | <address object>} |
syslog
{
address <value> |
connection-type {ssl | udp} |
default-domain-name <value> | syslog-parse-profile <value> |
}
setting
{
client-probing-interval <value> |
collectorname <value> |
edirectory-query-interval <value> |
enable-mapping-timeout {no | yes} |
enable-ntlm {no | yes} |
enable-probing {no | yes} |
enable-security-log {no | yes} |
enable-session {no | yes} |
set user-id-collector
ip-user-mapping-timeout <value> |
ntlm-domain <value> |
ntlm-password <value> |
ntlm-username <value> |
secret <value> |
security-log-interval <value> |
session-interval <value> |
wmi-account <value> |
wmi-password <value>
}
syslog-parse-profile <value>
{
description <value>;
field-identifier
{
address-delimiter <value>;
address-prefix <value>;
event-string <value>;
username-delimiter <value>;
username-prefix <value>;
}
regex-identifier
{
address-regex <value>;
event-regex <value>;
username-regex <value>;
}
}
}
Options
<name> Specifies the User ID collector to configure
> directory-server Directory servers to monitor
+ disabled Disabled (no or yes)
+ host IP address and network mask (x.x.x.x/y) or hostname for the directory server
+ server-profile LDAP server object name
+ type Type of directory server
active-directory Microsoft Active Directory
e-directory Novell eDirectory
exchange Microsoft Exchange
> ignore-user List of users to ignore (value or list of values enclosed in [ ])
> include-exclude-network Enter a name to identify the profile that will include or exclude a network for User-ID discovery
purposes. This option allows you to include or exclude a network range for IP address-to-user name mapping. Example, if
you exclude 10.1.1.0/24, User-ID will not try to find user names for IP addresses in the excluded range. This in turn will also
include or exclude ranges for mappings sent to other PAN-OS firewalls. When defining an include or exclude network range,
an implicit exclude-all will be performed. For example, if you include 10.1.1.0/24, all other networks will be excluded. If you
exclude 10.1.1.0/24, all networks will be excluded, so when using exclude you must also have an include network, otherwise
all networks are excluded.
+ disabled Disabled (no or yes)
+ discovery Exclude or Include (default is Include)
+ network-address Network address/prefix (x.x.x.x/y) to include or exclude
> include-exclude-network-sequence Include or exclude a network sequence
> server-monitor Settings for the server monitor
+ description Specify description
set user-id-collector
Syntax
set vsys <name> application <name>
{
tcp-half-closed-timeout <value> |
tcp-time-wait-timeout <value> |
tcp-timeout |
timeout |
udp-timeout
}
Options
* vsys <name> Name of the virtual system.
* application <name> Name of the application.
+ tcp-half-closed-timeout <value> Maximum time after the virtual system sees the first FIN and before the TCP session
closes, in seconds. (1-604800; default is the value of the global setting)
+ tcp-time-wait-timeout <value> Maximum time after the virtual system sees the second FIN or a RST and before the
TCP session closes, in seconds. (1-600; default is the value of the global setting)
+ tcp-timeout Maximum time before an idle TCP application flow is terminated, in seconds. (0-604800; default is the
value of the global setting)
+ timeout Maximum time before an idle application flow is terminated, in seconds. This timer is for protocols other than
TCP and UDP. (0-604800; default is the value of the global setting) A setting of 0 indicates that the default timeout of the
application will be used.
+ udp-timeout Maximum time before an idle UDP application flow is terminated, in seconds. (0-604800; default is the
value of the global setting) A setting of 0 indicates that the default timeout of the application will be used.
Syntax
set vsys <name> import
{
dns-proxy <value> |
network |
{
interface <value> |
virtual-router {default | <value>} |
virtual-wire {default-wire | <value>} |
vlan <value>
}
resource |
{
max-application-override-rules <value> |
max-concurrent-ssl-vpn-tunnels <value> |
max-cp-rules <value> |
max-dos-rules <value> |
max-nat-rules <value> |
max-pbf-rules <value> |
max-qos-rules <value> |
max-security-rules <value> |
max-sessions <value> |
max-site-to-site-vpn-tunnels <value> |
max-ssl-decryption-rules <value>
}
visible-vsys <value>
}
Options
+ dns-proxy DNS proxy object to use for resolving FQDNs
> network Network configuration
> interface Import interface (ethernet, loopback, tunnel, vlan, value or list of values enclosed in [ ])
> virtual-router Import virtual router (default, or value or list of values enclosed in [ ])
> virtual-wire Import virtual wire (default-wire, or value or list of values enclosed in [ ])
> vlan Import VLAN (value or list of values enclosed in [ ])
> resource Limits on resources used by this virtual system
+ max-application-override-rules Maximum number of application override rules allowed for this virtual system (0-2000)
+ max-concurrent-ssl-vpn-tunnels Maximum number of concurrent SSL VPN tunnels allowed for this virtual system (010000)
+ max-cp-rules Maximum number of captive portal rules allowed for this virtual system (0-2000)
+ max-dos-rules Maximum number of Denial of Service (DoS) rules allowed for this virtual system (0-1000)
+ max-nat-rules Maximum number of Network Address Translation (NAT) rules allowed for this virtual system (0-4000)
+ max-pbf-rules Maximum number of Policy-based Forwarding (PBF) rules allowed for this virtual system (0-500)
+ max-qos-rules Maximum number of Quality of Service (QoS) rules allowed for this virtual system (0-2000)
+ max-security-rules Maximum number of security rules allowed for this virtual system (0-20000)
+ max-sessions Maximum number of sessions allowed for this virtual system (0-4194290)
+ max-site-to-site-vpn-tunnels Maximum number of site-to-site VPN tunnels allowed for this virtual system (0-10000)
+ max-ssl-decryption-rules Maximum number of SSL decryption rules allowed for this virtual system (0-2000)
> visible-vsys Makes the specified virtual system visible to this virtual system, to create inter-vsys traffic
set zone
set zone
Configures security zones, which identify source and destination interfaces on the firewall for use in security policies.
Zones that are set using this command will appear in the list of zones when defining security policies and configuring interfaces.
Syntax
set zone <name>
{
enable-user-identification {no | yes} |
network |
{
log-setting <value> |
zone-protection-profile <value> |
layer2 <value> |
layer3 <value> |
tap <value> |
virtual-wire <value>
}
user-acl
{
+ exclude-list <value> |
+ include-list <value>
}
}
Options
<name> Specifies the zone to configure. A zone name can be up to 15 characters and can include only letters, numbers, spaces,
hyphens, periods, and underscores. The name is case-sensitive and must be unique.
+ enable-user-identification Enable user identification
> network Network configuration
+ log-setting Log setting for forwarding scan logs
+ zone-protection-profile Zone protection profile name
> layer2 Layer2 interfaces (member value or list of values enclosed in [ ])
> layer3 Layer3 interfaces (member value or list of values enclosed in [ ])
> tap Tap mode interfaces (member value or list of values enclosed in [ ])
> virtual-wire Virtual-wire interfaces (member value or list of values enclosed in [ ])
> user-acl User Access Control List (ACL) configuration
> exclude-list Exclude list (IP address and network mask (x.x.x.x/y) or list of values enclosed in [ ])
> include-list Include list (IP address and network mask (x.x.x.x/y) or list of values enclosed in [ ])
show
show
Displays information about the current candidate configuration.
Syntax
show <context>
Options
<context> Specifies a path through the hierarchy. For available contexts in the hierarchy, press <tab>.
Sample Output
The following command shows the full candidate hierarchy.
username@hostname# show
The following commands can be used to display the hierarchy segment for network interface.
Use the edit command to move to the level of the hierarchy, and then use the show command without specifying
context:
edit network interface
[edit network interface] show
Syntax
show deviceconfig setting ssl-decrypt
Options
None
Sample Output
The following command shows that the firewall generates certificates that use a 1024-bit RSA key for its connection
with the client regardless of the key size that the destination server uses.
username@hostname> show deviceconfig setting ssl-decrypt
ssl-decrypt {
notify-user no;
url-proxy yes;
answer-timeout 100;
fwd-proxy-server-cert-key-size 1024;
}
top
top
Changes context to the top hierarchy level.
Syntax
top
Options
None
Sample Output
The following command changes context from the network level of the hierarchy to the top level.
[edit network]
username@hostname# top
[edit]
username@hostname#
up
up
Changes context to the next higher hierarchy level.
Syntax
up
Options
None
Sample Output
The following command changes context from the network interface level of the hierarchy to the network level.
[edit network interface]
username@hostname# up
[edit network]
username@hostname#
up
Chapter 4
ls on page 384
clear
clear
Resets information, counters, sessions, or statistics.
Syntax
clear
{
application-signature statistics |
arp {all | <interface_name>} |
counter |
{
all |
global |
{
filter |
{
aspect <value> |
category <value> |
packet-filter {no | yes} |
severity <value>
}
name <value>
}
interface
}
dhcp lease |
{
all |
interface <value>
{
expired-only |
ip <ip> |
mac <mac_address>
}
}
dns-proxy |
{
cache {all | name <name>} domain-name <value> |
statistics {all | name <value>}
}
dos-protection |
{
rule <name> statistics |
zone <name> blocked {all | source <ip/netmask>}
}
high-availability {control-link statistics | transitions} |
job id <value> |
lacp counters aggregate-ethernet <all | ae-name>
log {acc | alarm | config | hipmatch | system | threat | traffic | userid}
|
log-collector stats runtime ld <value> segment <value> {active-segments
clear
{no | yes}} |
log-receiver netflow counters |
mac {all | <value>} |
nat-rule-cache rule <name> |
neighbor {all | <interface_name>} |
object dynamic {all | id <value>} |
pbf |
{
return-mac {all | name <name>} |
rule {all | name <name>}
}
pppoe interface <name> |
query {all-by-session | id <value>} |
report {all-by-session | id <value>} |
routing |
{
bgp virtual-router <name> |
{
dampening {prefix <ip/netmask> | peer <value>} |
stat peer <value>
}
multicast
{
igmp statistics {virtual-router <name>} |
pim statistics {virtual-router <name>}
}
}
session |
{
all |
{
filter application <value> |
filter destination <ip_address> |
filter destination-port <port_number> |
filter destination-user {known-user | unknown | <value>} |
filter dos-rule <rule_name> |
filter from <zone> |
filter hw-interface <interface_name> |
filter min-kb <value> |
filter nat {both | destination | none | source} |
filter nat-rule <rule_name> |
filter pbf-rule <rule_name> |
filter protocol <value> |
filter qos-class <value> |
filter qos-node-id <value> |
filter qos-rule <rule_name> |
filter rule <rule_name> |
filter source <ip_address> |
filter source-port <port_number> |
filter source-user {known-user | unknown | <value>} |
filter ssl-decrypt {no | yes} |
filter state {active | closed | closing | discard | initial |
opening} |
filter to <zone> |
clear
Options
> application-signature Clears application signature statistics
> arp Clears Address Resolution Protocol (ARP) information for a specified interface, loopback, or VLAN, or
all
> counter Clears counters
> all Clears all counters
> global Clears global counters only
> filter Apply counter filters
+ aspect Counter aspect
aa HA Active/Active mode
arp ARP processing
dos DoS protection
forward Packet forwarding
ipfrag IP fragment processing
mgmt Management plane packet
mld MLD processing
nd ND processing
offload Hardware offload
parse Packet parsing
pktproc Packet processing
qos QoS enforcement
resource Resource management
session Session setup/teardown
system System function
tunnel Tunnel encryption/decryption
+ category Counter category
aho AHO match engine
appid Application identification
ctd Content identification
dfa DFA match engine
dlp DLP
flow Packet processing
fpga FPGA
ha High Availability
clear
log Logging
nat Network Address Translation
packet Packet buffer
proxy TCP proxy
session Session management
ssh SSH termination
ssl SSL termination
tcp TCP reordering
url URL filtering
zip ZIP processing
+ packet-filter Counters for packet that matches debug filter (no or yes)
+ severity Counter for severity (drop, error, informational, or warning)
> name Counter name
> interface Clears interface counters only
> dhcp Clears Dynamic Host Configuration Protocol (DHCP) leases
> all Clears leases on all interfaces
> interface Clears leases on a specific interface
> expired-only Clears expired leases
> ip Clears lease for the specified IP address (x.x.x.x or IPv6)
> mac Clears lease for the specified MAC address (xx:xx:xx:xx:xx:xx)
> dns-proxy Clears DNS proxy information
> cache Clears DNS proxy cache
> all Clears all DNS proxy caches (option to provide the domain name)
> name Clears DNS proxy object name (option to provide the domain name)
> statistics Clears DNS proxy statistics
> all Clears all DNS proxy statistics
> name Clears DNS proxy object name
> dos-protection Clears Denial of Service (DoS) protection-related information
> rule DoS protection rule name
> zone Source zone name
> all Clears all IP addresses
> source Specify source IP addresses to unblock (x.x.x.x/y or IPv6/netmask)
> high-availability Clears high-availability statistics
> control-link Clears high-availability control-link information
> transitions Clears high-availability transition statistics
> job Clears download jobs (0-4294967295)
> lacp counters aggregate-ethernet <all | ae-name> Clears Link Aggregation Control Protocol (LACP) statistics
> log Removes logs on disk
> acc ACC database
> alarm Alarm logs
> config Configuration logs
> system System logs
> threat Threat logs
> traffic Traffic logs
Note: The clear log options to clear individual log types (acc, alarm, config, etc.) is not supported on the Panorama
M-100 appliance. If you need to clear all logs, including the configuration, you can use the request system
private-data-reset command. Do not run this command unless your configuration is backed up.
> log-collector Clears the log collector statistics
+ active-segments Only display active segments
* ld Logical disk number (1-4)
* segment Segment ID (all or 0-255)
> log-receiver Clears the NetFlow counters
> mac Clears MAC information (all or specific VLAN MAC information dot1q-vlan)
> nat-rule-cache Clears the specified dynamic IP Network Address Translation (NAT) rule IP pool cache
> neighbor Clears the neighbor cache (all or specified interface neighbor cache entries)
clear
clear
> url Clears the specified URL from data plane (For the Palo Alto Networks URL filtering database only)
> user-cache Clears the IP-to-user cache in the data plane (all or specified IP, x.x.x.x/y or IPv6)
> user-cache-mp Clears the management plane user cache
> all Clears all ip to user cache in management plane
> ip Clears the specified IP to user cache in management plane (IP address and network mask, x.x.x.x/y)
> vpn Clears Internet Key Exchange (IKE) or IP Security (IPSec) VPN runtime objects
> flow Clears the VPN tunnel on the data plane. Specify the tunnel or press Enter to apply to all tunnels.
> ike-sa Removes the active IKE Security Association (SA) and stops all ongoing key negotiations.
Specify the gateway or press Enter to apply to all gateways.
> ipsec-sa Deactivates the IPsec SA for a tunnel or all tunnels. Specify the tunnel or press Enter to apply to
all tunnels.
> wildfire Clears the Wildfire statistics counters
Sample Output
The following command clears the session with ID 2245.
username@hostname> clear session id 2245
Session 2245 cleared
username@hostname>
commit-all
commit-all
(Panorama only) Commits a specified configuration, policy, or template. Applies the candidate
configuration to the firewall. A committed configuration becomes the active configuration for the
device.
Syntax
commit-all
{
log-collector-config log-collector-group <name> |
shared-policy |
{
device <value> |
include-template {no | yes} |
merge-with-candidate-cfg {no | yes} |
remove-overridden-objects {no | yes} |
device-group <value> |
vsys <value>
}
template
{
merge-with-candidate-cfg {no | yes} |
remove-overridden-objects {no | yes} |
name <value> |
device <value>
}
}
Options
> log-collector-config Log collector configuration to commit
+ log-collector-group Log collector group name
> shared-policy Shared policy to commit
+ device Device serial number
+ include-template Whether to include relevant template
+ merge-with-candidate-cfg Whether to merge with candidate configuration
+ remove-overridden-objects Whether to remove overridden template objects on the device
* device-group Device group name
> vsys Virtual system name, or list of names separated by [ ]
> template Template to commit
+ merge-with-candidate-cfg Whether to merge with candidate configuration
+ remove-overridden-objects Whether to remove overridden template objects on the device
* name Template name
> device Device name, or list of names separated by [ ]
configure
configure
Enters Configuration mode.
Syntax
configure
Options
None
Sample Output
To enter Configuration mode from Operational mode, enter the following command.
username@hostname> configure
Entering configuration mode
[edit]
username@hostname#
debug authd
debug authd
Defines settings for authd service debug logging.
Syntax
debug authd {off | on | show}
Options
> off Turns off debug logging
> on Turns on authd service debug logging
> show Displays current debug logging setting
Sample Output
The following command turns the authd debugging option on.
admin@PA-HDF> debug authd on
admin@PA-HDF>
debug cli
debug cli
Defines settings and display information for debugging the CLI connection.
Syntax
debug cli
{
detail |
off |
on |
show
}
Options
> detail Shows details information about the CLI connection
> off Turns the debugging option off
> on Turns the debugging option on
> show Shows whether this command is on or off
Sample Output
The following command shows details of the CLI connection.
admin@PA-HDF> debug cli detail
Environment variables :
(USER . admin)
(LOGNAME . admin)
(HOME . /home/admin)
(PATH . /usr/local/bin:/bin:/usr/bin)
(MAIL . /var/mail/admin)
(SHELL . /bin/bash)
(SSH_CLIENT . 10.31.1.104 1109 22)
(SSH_CONNECTION . 10.31.1.104 1109 10.1.7.2 22)
(SSH_TTY . /dev/pts/0)
(TERM . vt100)
(LINES . 24)
(COLUMNS . 80)
(PAN_BASE_DIR . /opt/pancfg/mgmt)
PAN_BUILD_TYPE : DEVELOPMENT
Total Heap : 7.00 M
Used
: 5.51 M
Nursery
: 0.12 M
admin@PA-HDF>
debug cryptod
debug cryptod
Sets the debug options for the cryptod daemon.
Syntax
debug cryptod
{
global {off | on | show}
show counters
}
Options
> global Controls debug levels
> show Shows whether this command is on or off
> off Turns the debugging option off
> on Turns the debugging option on
> show Shows Cryptod debug counters
Sample Output
The following command displays the current cryptod debugging setting.
admin@PA-HDF> debug cryptod global show
sw.cryptod.runtime.debug.level: debug
admin@PA-HDF>
debug dataplane
debug dataplane
Configures settings for debugging the data plane.
Syntax
debug dataplane
{
device switch-dx |
{
fdb {dump | index <value>} |
port-based-vlan port <value> |
register read <value> |
uplink |
vlan-table {dump | index <value>} |
}
flow-control {disable | enable} |
fpga |
{
set {sw_aho | sw_dfa | sw_dlp} {no | yes} |
state
}
internal |
{
pdt |
{
lion |
{
egr |
{
nexthop dump |
queues type {active | all | flags | high} |
route dump |
stats
}
igr |
{
drops |
flow dump {id <value> | offset <value> | verbose {no | yes}} |
info |
interface {dump | info} |
mac dump |
port {dump | stats} |
queues type {active | all | flags | high}
}
mac stats |
spi stats
}
nac |
{
aho dump {table <value>} instance <value> |
dfa dump {table <value>} instance <value> |
debug dataplane
debug dataplane
debug dataplane
{
all |
capture |
{
all |
snaplen |
stage {drop | firewall | receive | transmit} |
trigger application
}
filter {all | <filter_index>} |
log
{
counter {all | <value>} |
feature |
{
all |
appid {agt | all | basic | dfa | policy} |
cfg {agent | all | basic | config} |
ctd {all | basic | detector | sml | url} |
flow {ager | all | arp | basic | ha | nd | np | receive} |
misc {all | misc} |
module {aho | all | dfa | scan | url} |
pow {all | basic} |
proxy {all | basic} |
ssl {all | basic} |
tcp {all | fptcp | reass} |
tunnel {ager | flow} |
zip {all | basic}
}
log
}
}
set |
{
capture |
{
off |
on |
snaplen <value> |
stage {drop | firewall | receive | transmit} file <file_name> |
{
byte-count <value> |
packet-count <value>
}
trigger application file <file_name> from <application_name> to
<application_name>
{
byte-count <value> |
packet-count <value>
}
}
filter |
{
index <value> |
debug dataplane
match |
{
destination <ip_address> |
destination-port <port> |
ingress-interface <interface_name> |
ipv6-only {no | yes} |
non-ip {exclude | include | only} |
protocol <value> |
source <ip_address> |
source-port <port>
}
off |
on |
pre-parse-match {yes | no}
}
log
{
counter <value> |
feature |
{
all |
appid {agt | all | basic | dfa | policy} |
cfg {agent | all | basic | config} |
ctd {all | basic | detector | sml | url} |
flow {ager | all | arp | basic | ha | nd | np | receive} |
misc {all | misc} |
module {aho | all | dfa | scan | url} |
pow {all | basic} |
proxy {all | basic} |
ssl {all | basic} |
tcp {all | fptcp | reass} |
tunnel {ager | flow} |
url_trie {all | basic | stat} |
zip {all | basic}
}
log-option throttle {no | yes} |
off |
on
}
}
show setting
}
pool |
{
check {hardware <value> | software <value>} |
mem file <file_name> size <value> start <value> {mode <value>} |
statistics
}
pow |
{
performance {all} |
status
}
process {comm | ha-agent | mprelay | task} {on | off | show} |
debug dataplane
reset |
{
appid {cache | statistics | unknown-cache {destination <ip_address>}} |
ctd {regex-stats | url-block-cache {lockout}} |
dos |
{
block-table |
classification-table |
rule <name> classification-table |
zone <name> block-table {all | source <ip_address>}
}
logging |
pow |
ssl-decrypt
{
certificate-cache |
certificate-status |
exclude-cache |
host-certificate-cache |
notify-cache {source <ip_address>}
}
username-cache
}
show |
{
cfg-memstat statistics |
com statistics |
ctd |
{
aggregate-table |
athreat {tid <value>} |
driveby-table |
pcap-cache |
regex-group {dump} |
regex-stats {dump} |
sml-cache |
threat cid <value> id <value> |
version
}
dos |
{
block-table |
classification-table |
rule <name> classification-table |
zone <name> block-table
}
url-cache statistics |
username-cache
}
task-heartbeat {off| on | show} |
tcp state |
test
{
nat-policy-add |
debug dataplane
{
destination <ip_address> |
destination-port <port_number> |
from <zone> |
protocol <value> |
source <ip_address> |
source-port <port_number> |
to <zone>
}
nat-policy-del |
{
destination <ip_address> |
destination-port <port_number> |
from <zone> |
protocol <value> |
source <ip_address> |
source-port <port_number> |
to <zone> |
translate-source <ip_address> |
translate-source-port <port_number>
}
url-cache-resolve-path {max-per-sec <value>
url-resolve-path <value> |
}
}
Options
> device Debugs data plane hardware component
> fdb Debugs fdb (option to dump or provide index, 0-65535)
> port-based-vlan Debugs port-based VLAN port (0-32)
> register Debugs register read (0-4294967295)
> uplink Debugs uplink
> vlan-table Debugs VLAN table (option to dump or provide index, 0-4095)
> flow-control Enables or disables flow control
> fpga Debugs the field programmable gate array (FPGA) content
> set Sets the runtime flag (option to use only software for aho, dfa, or dlp)
> state Shows the FPGA state
> internal Debugs data plane internal state
> fpp statistics Shows FPP state
> path Shows sample and display debugging counters along a path
> nodes Show the nodes available on this system
> sample Sample counters along a path
+ filter Counter filter setting
+ show-zero Enable display of empty counters
* nodes
List of nodes describing a path to sample, like: "s1.p1 s1.dp0"
> pdt Internal diagnostic tool
> lion Options are egr, igr, mac, and spi
> fe20 Options are acl, flow, lagmap, lif, mac, mymac, nexthop, port, qmap, rd, route, show, spaui,
sram, stats, xaui, xge, xge20g
> fpp Options are event, gft, predict, show, sw, vsys, xaui, xge
> jaguar Options are cip, rd, show, xaui, xge
> marvell Options are portmap, porttag, stats
> nac Options are aho dump, dfa dump, info, and stats
debug dataplane
> oct Options are bootmem, csr, fpa, pip, pko, and pow
> petra Options are counter, lport, show
> se20 Options are aurora, show, sram, stats, xaui, xge
> vif Shows virtual interface configuration (address, link, route, rule, or vr)
> memory Examines data plane memory
> monitor Debugs data plane monitor details (off, on, or show current debug setting)
> nat Debugs the specified Network Address Translation (NAT) sync IP pool rule
> packet-diag Performs packet captures and configures pcap filter and trigger criterion
> clear Clears packet-related diagnosis parameters
> all Clears all settings and turns off log/capture
> capture Clears capture setting
> all All settings
> snaplen Packet capture snap length
> stage Capture at processing stage (drop, firewall, receive, or transmit)
> trigger Capture triggered by event
> filter Clears packet filter (all or specified filter index, 1-4)
> log Clears log setting
> counter Disables logging for global counter changes (all or specified counter value)
> feature Disables feature/module to log
> all Disables all
> appid Disables appid logging (agt, all, basic, dfa, or policy)
> cfg Disables cfg logging (agent, all, basic, or config)
> ctd Disables ctd logging (all, basic, detector, sml, or url)
> flow Disables flow logging (ager, all, arp, basic, ha, nd, np, or receive)
> misc Disables misc logging (all or miscellaneous)
> module Disables module logging (aho, all, dfa, scan, or url)
> pow Disables pow logging (all or basic)
> proxy Disables proxy logging (all or basic)
> ssl Disables SSL logging (all or basic)
> tcp Disables TCP logging (all, fptcp, or reass)
> tunnel Disables tunnel logging (ager or flow)
> zip Disables zip logging (all or basic)
> log Clears debug logs
> set Sets packet-related debugging parameters
> capture Debugs capture setting
> off Disables debug capture
> on Enables debug capture
> snaplen Packet capture snap length (40-65535)
> stage Packet capture at processing stage (drop, firewall, receive, or transmit)
+ byte-count Maximum byte count before filter stops (1-1073741824)
+ packet-count Maximum packet count before filter stops (1-1073741824)
* file Saved file name (alphanumeric string [ 0-9a-zA-Z._-])
> trigger Packet capture triggered by event
+ byte-count Maximum byte count before filter stops (1-1073741824)
+ packet-count Maximum packet count before filter stops (1-1073741824)
* file Saved file name (alphanumeric string [ 0-9a-zA-Z._-])
* from From application (enter an application name or press <tab> to view a list)
* to To application (enter an application name or press <tab> to view a list)
> filter Debugs filter setting
> index Modifies debug filter with specified index (1-4)
> match Adds a new debug filter and specifies matching options
+ destination Destination IP address (x.x.x.x or IPv6)
+ destination-port Destination port (1-65535)
+ ingress-interface Ingress hardware interface name
debug dataplane
debug dataplane
debug dataplane
Sample Output
The following command shows the statistics for the data plane buffer pools.
admin@PA-HDF> debug dataplane pool statistics
Hardware Pools
[ 0] Packet Buffers
[ 1] Work Queue Entries
[ 2] Output Buffers
[ 3] DFA Result
DFA Result
[ 4] Timer Buffers
Timer Buffers
[ 5] PAN_FPA_LWM_POOL
[ 6] PAN_FPA_ZIP_POOL
[ 7] PAN_FPA_BLAST_POOL
Software Pools
[ 0] software packet buffer
[ 1] software packet buffer
[ 2] software packet buffer
[ 3] software packet buffer
[ 4] software packet buffer
[ 5] Pktlog logs
[ 6] Pktlog threats
[ 7] Pktlog packet
[ 8] Pktlog large
[ 9] CTD Flow
[10] CTD AV Block
[11] SML VM Fields
[12] SML VM Vchecks
[13] Detector Threats
[14] CTD DLP FLOW
[15] CTD DLP DATA
[16] CTD DECODE FILTER
0
1
2
3
4
:
:
:
:
:
:
:
:
:
:
57241/57344
229284/229376
1000/1024
2048/2048
0x8000000410000000
0x8000000417000000
0x8000000418c00000
0x8000000419100000
4092/4096
0x8000000418d00000
8192/8192
1024/1024
64/64
0x8000000419300000
0x8000000419500000
0x8000000419700000
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
16352/16384
8192/8192
8191/8192
4191/4192
256/256
10000/10000
4999/5000
5000/5000
56/56
261712/262144
32/32
261695/262144
65536/65536
261699/262144
65532/65536
4096/4096
16380/16384
0x8000000021b40680
0x8000000022354780
0x8000000022b5e880
0x8000000023b68980
0x800000002c079c00
0x800000002d0a74e0
0x800000002d2c2ea0
0x800000002d3d0c00
0x800000002dc626a0
0x80000000412e3080
0x8000000058ef02e8
0x8000000058ef8468
0x8000000059838568
0x8000000059988668
0x800000005adf24d0
0x800000005b6425d0
0x800000005ba476d8
debug dataplane
[17]
[18]
[19]
[20]
[21]
[22]
[23]
[24]
Regex Results
TIMER Chunk
FPTCP segs
Proxy session
SSL Handshake State
SSL State
SSH Handshake State
SSH State
:
:
:
:
:
:
:
:
2048/2048
131072/131072
32768/32768
1024/1024
1024/1024
2048/2048
64/64
512/512
MaxRawPerc
53
99
99
100
0
0x800000005bafc088
0x8000000063f3a7c0
0x8000000065fda8c0
0x80000000660829c0
0x80000000660d9ec0
0x80000000662773c0
0x80000000662edcc0
0x800000006633b8c0
MaxPerc
100
100
100
100
0
The following command displays the settings for data plane packet diagnostics.
admin@PA-HDF> debug dataplane packet-diag show setting
----------------------------------------------------------------------Packet diagnosis setting:
----------------------------------------------------------------------Packet filter
Enabled:
no
Match pre-parsed packet:
no
----------------------------------------------------------------------Logging
Enabled:
no
Log-throttle:
no
Output file size:
3306 of 10485760 Bytes
Features:
Counters:
----------------------------------------------------------------------Packet capture
Enabled:
no
-----------------------------------------------------------------------
The following example sets up a packet capture session. Note: For detailed technotes, search the Palo
Alto Networks support site at https://live.paloaltonetworks.com/community/knowledgepoint.
1. Create a filter to limit the amount of data that the packet capture will collect. In this configuration,
only traffic for sessions sourced from IP 10.16.0.33 will be captured.
admin@PA-HDF> debug dataplane packet-diag set filter match source 10.16.0.33
3. Create a capture trigger that will begin capturing the pcap when an App-ID changes from webbrowsing to gmail.
admin@PA-HDF> debug dataplane packet-diag set capture trigger application
from web-browsing to gmail-base file gmailpcap
debug dataplane
6. After the capture is complete, disable it to prevent performance degradation due to filtering and
PCAP.
admin@PA-HDF> debug dataplane packet-diag set filter off
admin@PA-HDF> debug dataplane packet-diag set capture off
debug device-server
debug device-server
Configures settings for debugging the device server.
Syntax
debug device-server
{
bc-url-db |
{
bloom-stats |
bloom-verify-basedb |
cache-clear |
cache-enable {no | yes} |
cache-load |
cache-resize <value> |
cache-save |
db-info |
show-stats
}
clear |
dump |
{
com {all | opcmd | sshkey | status | url} |
dynamic-url |
{
database {category <value> | start-from <value>} |
statistics
}
idmgr |
{
high-availability state |
type
{
custom-url-filter {all | id <value> | name <name>} |
global-interface {all | id <value> | name <name>} |
global-rib-instance {all | id <value> | name <name>} |
global-tunnel {all | id <value> | name <name>} |
global-vlan {all | id <value> | name <name>} |
global-vlan-domain {all | id <value> | name <name>} |
global-vrouter {all | id <value> | name <name>} |
ike-gateway {all | id <value> | name <name>} |
nat-rule {all | id <value> | name <name>} |
pbf-rule {all | id <value> | name <name>} |
security-rule {all | id <value> | name <name>} |
shared-application {all | id <value> | name <name>} |
shared-custom-url-category {all | id <value> | name <name>} |
shared-gateway {all | id <value> | name <name>} |
shared-region {all | id <value> | name <name>} |
ssl-rule {all | id <value> | name <name>} |
vsys {all | id <value> | name <name>} |
vsys-application {all | id <value> | name <name>} |
debug device-server
debug device-server
}
save dynamic-url-database |
set |
{
all |
base {all | config | ha | id} |
config {all | basic | fpga | tdb} |
misc {all | basic} |
tdb {aho | all | basic} |
third-party {all | libcurl} |
url {all | basic | cloud | ha | match | rfs | stat} |
url_trie {all | basic | stat}
}
show |
test |
{
admin-override-password <value> |
botnet-domain |
dynamic-url {async | cloud | unknown-only} {no | yes} |
url-category <value> |
url-update-server
}
unset
{
all |
base {all | config | ha | id} |
config {all | basic | fpga | tdb} |
misc {all | basic} |
tdb {aho | all | basic} |
third-party {all | libcurl} |
url {all | basic}
}
}
Options
> bc-url-db Debugs BrightCloud URL database (for BrightCloud only)
> bloom-stats Shows bloom filter stats
> bloom-verify-basedb Verifies base database with bloom filter
> cache-clear Clears database access cache
> cache-enable Enables/disables cache for database access
> cache-load Loads database access cache
> cache-resize Resizes database cache (1-1000000)
> cache-save Saves database access cache
> db-info Shows database info
> show-stats Shows URL database access statistics
> clear Clears all debug logs
> dump Dumps the debug data
> com Dumps com messages statistics
> all Dumps all messages statistics
> opcmd Dumps opcmd messages statistics
> sshkey Dumps SSH key messages statistics
> status Dumps status messages statistics
> url Dumps URL messages statistics
debug device-server
debug device-server
debug device-server
Sample Output
The following command turns off debug logging for the device server.
admin@PA-HDF> debug device-server off
admin@PA-HDF>
debug dhcpd
debug dhcpd
Configures settings for debugging the Dynamic Host Configuration Protocol (DHCP) daemon.
Syntax
debug dhcpd
{
global {on | off | show} |
pcap {delete | on | off | show | view} |
show objects
}
Options
> global Defines settings for the global DHCP daemon
> pcap Defines settings for debugging packet capture
> show Displays DHCP client debug information
Sample Output
The following command displays current global DHCP daemon settings.
admin@PA-HDF> debug dhcpd global show
sw.dhcpd.runtime.debug.level: debug
admin@PA-HDF>
debug dnsproxyd
debug dnsproxyd
Configures settings for the Domain Name Server (DNS) proxy daemon.
Syntax
debug dnsproxyd
{
global {off | on | show} |
show {batches | connections | objects | persistent}
}
Options
> global Controls debug levels
> show Shows DNS proxy debug information
> batches Displays DNS proxy batch requests
> connections Displays DNS proxy connections
> objects Displays DNS proxy object debug
> persistent Displays DNS proxy persistent cache entries on disk
Sample Output
The following command displays the DNS proxy object debug.
admin@PA-HDF> debug dnsproxyd show objects
--------------CFG OBJS--------------CFG obj name: mgmt-obj (0x1039ff74)
--------------RT OBJS--------------RT obj name: mgmt-obj (0x1020ae28)
obj addr:0x1020ae28
def_name_servers:0x1037a384
tom:0x101b08e4
dnscache:0x101b09e4
Interface:mgmt-if
10.1.7.16
-------IP OBJ HASH TBL-------------ip: 10.1.7.16 for dns rt obj:mgmt-obj
admin@PA-HDF>
debug global-protect
debug global-protect
Configures settings for debugging the GlobalProtect portal.
Syntax
debug global-protect portal {interval <value> | off | on}
Options
> interval Interval to send HIP report (60-86400)
> off Turn off debugging
> on Turn on debugging
Sample Output
The following command turns on GlobalProtect debugging.
admin@PA-HDF> debug global-protect portal on
admin@PA-HDF>
debug high-availability-agent
debug high-availability-agent
Configures settings for debugging the high availability agent.
Syntax
debug high-availability-agent
{
internal-dump |
off |
on |
show
}
Options
> internal-dump Dumps the internal state of the agent to its log
> off Turns the debugging option off
> on Turns the debugging option on
> show Displays current debug logging setting
debug ike
debug ike
Configures settings for debugging Internet Key Exchange (IKE) daemon.
Syntax
debug ike
{
global {off | on | show} |
pcap {delete | off | on | show | view} |
socket |
stat
}
Options
> global Configures global settings
> pcap Configures packet capture settings
> socket Configures socket settings
> stat Shows IKE daemon statistics
Sample Output
The following command turns on the global options for debugging the IKE daemon.
admin@PA-HDF> debug ike global on
admin@PA-HDF>
debug keymgr
debug keymgr
Configures settings for debugging the key manager daemon.
Syntax
debug keymgr
{
list-sa |
off |
on |
show
}
Options
> list-sa Lists the IPSec security associations (SAs) that are stored in the key manager daemon
> off Turns the settings off
> on Turns the settings on
> show Shows key manager daemon information
Sample Output
The following command shows the current information on the key manager daemon.
admin@PA-HDF> debug keymgr show
sw.keymgr.debug.global: normal
admin@PA-HDF>
debug l3svc
debug l3svc
Configures settings for debugging the Layer 3 Switched Virtual Connection (L3SVC).
Syntax
debug l3svc
{
clear |
off |
on {debug | dump | error | info | warn} |
pcap {delete | off | on | show | view} |
reset user-cache {all | <value>} |
show user-cache
}
Options
> clear Clears the debug logs
> off Turns the debugging option off
> on Turns the debugging option on
> pcap Configures packet capture settings
> reset Resets the user cache
> show Displays the user cache
Sample Output
The following command turns on L3SVC debugging.
admin@PA-HDF> debug l3svc on debug
admin@PA-HDF>
debug log-card-interface
debug log-card-interface
Shows log-card networking interface information.
Syntax
debug log-card-interface
{
info slot <value> |
ping host <value> slot <value> |
}
Options
> info Show log card networking interface information.
> ping Perform ping operation from the log card interface
debug log-collector-group
debug log-collector-group
Configures settings for debugging log collector groups.
Syntax
debug log-collector-group show
{
local {no | yes} |
name <value> |
segment <value>
}
Options
+ local Show local ring (yes/no)
+ name Log collector group name
+ segment Show segment ID (0-1000000)
debug log-receiver
debug log-receiver
Configures settings for debugging the log receiver daemon.
Syntax
debug log-receiver
{
container-page {entries <value> | off | on | timeout <value>} |
fwd {off | on | show} |
netflow {clear | statistics}
off |
on {debug | dump | normal} |
show |
statistics |
}
Options
> container-page Configures container page usage
> entries Specifies cache entries (4-65536)
> off Turns off container page caching
> on Turns on container page caching
> timeout Specifies cache timeout (1-86400)
> fwd Configures forwarding
> off Turns off forwarding
> on Turns on forwarding
> show Shows whether this command is on or off
> netflow NetFlow log receiver clear and show statistics commands
> off Turns the debugging option off
> on Turns the debugging option on (option to select debug, dump, or normal)
> show Shows whether this command is on or off
> statistics Shows log receiver daemon statistics
Sample Output
The following command turns log receiver debugging on.
admin@PA-HDF> debug log-receiver on
admin@PA-HDF>
debug logview
debug logview
Shows log-card networking interface information.
Syntax
debug log-card-interface
{
component <value> |
display-forward {no | yes} |
end-time <value> |
max-logs <value> |
quiet {no | yes} |
role <value> |
severity <value> |
slot <value> |
start-time <value> |
thorough {no | yes} |
}
Options
+ component For multiple components specify with comma separated. ex: dagger,sysd
+ display-forward default display is reverse
+ end-time Datetime YYYY/MM/DD@hh:mm:ss (e.g. 2013/03/02@10:00:00)
+ max-logs Number of logs to display min 100 and max 20000. Default 2000
+ quiet Quiet mode: Just print log count default is false
+ role For multiple roles specify with comma separated. ex: mp,cp,dp
+ severity For multiple severities specify with comma separated. ex: error,info
+ slot For multiple slots specify with comma separated. ex: 1,2
+ start-time Datetime YYYY/MM/DD@hh:mm:ss (e.g. 2013/03/01@10:00:00)
+ thorough Perform thorough search default is quick mode
debug management-server
debug management-server
Configures settings for debugging the management server.
Syntax
debug management-server
clear |
client {disable <value> | enable <value>} |
conn |
db-intervals db {dailythsum | dailytrsum | hourlythsum | hourlytrsum |
thsum | trsum | weeklythsum | weeklytrsum} |
{
end-time <value> |
period {last-12-hours | last-24-hrs | last-30-days | last-7-calendardays | last-7-days | last-calendar-day | last-calendar-month | lastcalendar-week | last-hour} |
start-time <value>
}
db-rollup {off | on} |
inter-log-collector status |
off |
on {debug | dump | error | info | warn} |
rolledup-intervals db {thsum | trsum} |
{
end-time <value> |
period {last-12-hours | last-24-hrs | last-30-days | last-7-calendardays | last-7-days | last-calendar-day | last-calendar-month | lastcalendar-week | last-hour} |
start-time <value>
}
set |
{
all |
auth {all | basic | detail} |
cfg {all | basic | detail} |
comm {all | basic | detail} |
dynupdsch {all | basic | detail} |
commit {all | basic | detail} |
commoncriteria {all | basic | detail} |
content {all | basic | detail} |
fqdn {all | basic | detail} |
log {all | basic | detail} |
logaction {all | basic | detail} |
logforwarding {all | basic | detail} |
logquery {all | basic | detail} |
panorama {all | basic | detail} |
proxy {all | basic | detail} |
report {all | basic | detail} |
schema {all | basic | detail} |
server {all | basic | detail} |
debug management-server
Options
> clear Clears all debug logs
> client Enables or disables management server client processes
authd authd daemon
device Device server
dhcpd DHCP server
ha_agent High-Availability server
ikemgr IKE manager
l3svc HTTP Daemon
ldapd LDAP Daemon
logrcvr Log Receiver daemon
npagent Network Processor agent
pppoed PPPoE daemon
rasmgr Remote Access Daemon
routed Routing daemon
sslmgr sslmgr daemon
sslvpn sslvpn daemon
> conn Prints management server conn entries
> db-intervals Displays available summary intervals for a given period
+ end-time End Time, e.g. 2008/12/31 11:59:59
+ period Select from available time periods
+ start-time Start Time, e.g. 2008/01/01 09:00:00
* db Database to display
> db-rollup Enables or disables summary database roll up
debug management-server
debug management-server
Sample Output
The following example turns management server debugging on.
admin@PA-HDF> debug management-server on
(null)
admin@PA-HDF>
The following example enables the management server network processor agent.
admin@PA-HDF> debug management-server client enable npagent
admin@PA-HDF>
The following example displays all of the available hourly summary intervals for the trsum database.
username@hostname> debug management-server db-intervals period last-calendarday db hourlytrsum
hourlytrsum periods from 2011/06/15 00:00:00 to 2011/06/15 23:59:59
hourlytrsum 2011/06/15 00:00:00 to 2011/06/15 11:59:59
hourlytrsum 2011/06/15 13:00:00 to 2011/06/15 23:59:59
The following example displays the breakdown of the trsum report into summary-based partial reports.
username@hostname> debug management-server rolledup-intervals period last-7days db trsum
Rolled up periods from 2011/02/17 14:03:38 to 2011/02/24 14:03:37
trsum 2011/02/17 14:03:38 to 2011/02/19 23:59:59
dailytrsum 2011/02/20 00:00:00 to 2011/02/23 23:59:59
hourlytrsum 2011/02/24 00:00:00 to 2011/02/24 13:59:59
debug master-service
debug master-service
Configures settings for debugging the master service.
Syntax
debug master-service
{
internal-dump |
off |
on {debug | dump | error | info | warn} |
show
}
Options
> internal-dump Dumps internal state of service to its log
> off Turns off debug logging
> on Turns on masterd service debug logging
debug Only output error, warning, info and debug logs
dump Output all logs
error Only output error logs
info Only output error, warning and info logs
warn Only output error and warning logs
> show Displays current debug logging setting
Sample Output
The following command dumps the internal state of the master server to the log.
admin@PA-HDF> debug master-service internal-dump
admin@PA-HDF>
debug mprelay
debug mprelay
Configures settings for debugging management plane relay.
Syntax
debug mpreplay
{
off |
on {debug | dump | error | info | warn} |
show
}
Options
> off Turns off debug logging
> on Turns on debug logging
debug Only output error, warning, info and debug logs
dump Output all logs
error Only output error logs
info Only output error, warning and info logs
warn Only output error and warning logs
> show Displays current debug logging setting
debug netconfig-agent
debug netconfig-agent
Defines settings for debugging the network configuration agent.
Syntax
debug netconfig-agent {off | on | show}
Options
> off Turns off network configuration agent debugging
> on Turns on network configuration agent debugging
> show Displays current debug setting
Sample Output
The following command turns on debugging of the network configuration agent.
admin@PA-HDF> debug netconfig-agent on
admin@PA-HDF>
debug pppoed
debug pppoed
Configures settings for debugging the Point-to-Point Protocol over Ethernet (PPPoE) daemon. The
firewall can be configured to be a PPPoE termination point to support connectivity in a Digital
Subscriber Line (DSL) environment where there is a DSL modem but no other PPPoE device to
terminate the connection.
Syntax
debug pppoed
{
global {off | on | show} |
pcap |
{
delete |
off |
on {virtualrouter <value>} |
show |
view
}
show interface {all | <interface_name>}
}
Options
> global Sets debugging options
> pcap Performs packet capture (option to filter result by virtual router)
> show interface Shows PPPoE debug information (all or specify an interface)
Sample Output
The following command turns packet capture debugging off.
admin@PA-HDF> debug pppoed pcap off
debug level set to error
admin@PA-HDF>
debug rasmgr
debug rasmgr
Configures settings for debugging the remote access service daemon.
Syntax
debug rasmgr
{
off |
on {debug | dump | normal} |
show |
statistics {all | reset}
}
Options
> off Turns the debugging option off
> on Turns the debugging option on (option to specify debug, dump, or normal)
> show Shows whether this command is on or off
> statistics Shows or resets statistics counters
Sample Output
The following command shows the debug settings for the remote access service daemon.
admin@PA-HDF> debug rasmgr show
sw.rasmgr.debug.global: normal
admin@PA-HDF>
debug routing
debug routing
Configures settings for debugging the route daemon.
Syntax
debug routing
{
fib {flush | stats} |
global {off | on | show} |
ifmon |
list-mib |
mib <value> |
mpf stats |
pcap |
{
all {delete | off | on | view} |
bgp {delete | off | on | view} |
igmp {delete | off | on | view} |
ospf {delete | off | on | view} |
pim {delete | off | on | view} |
rip {delete | off | on | view} |
show
}
restart |
socket
}
Options
> fib Turns on debugging for the forwarding table
> flush Forces forwarding table sync
> stats Shows route message stats
> global Turns on global debugging
> ifmon Shows interface monitor status
> list-mib Shows the routing list with management information base (MIB) names
> mib Shows the MIB tables
> mpf Displays multicast packet forwarder statistics
> pcap Shows packet capture data (all, BGP, OSPF, RIP)
> restart Restarts the routing process
> socket Shows socket data
Sample Output
The following command displays the MIB tables for routing.
admin@PA-HDF> debug routing list-mib
i3EmuTable (1 entries)
==========================
sckTable (0 entries)
sckSimInterfaceTable (0 entries)
debug routing
sckEiTable (0 entries)
sckEaTable (0 entries)
i3Table (0 entries)
i3EiTable (0 entries)
i3EaTable (0 entries)
i3EtTable (0 entries)
i3EmTable (0 entries)
dcSMLocationTable (0 entries)
dcSMHMTestActionObjects (0 entries)
siNode (0 entries)
siOSFailures (0 entries)
siTraceControl (0 entries)
siExecAction (0 entries)
...
admin@PA-HDF>
debug satd
debug satd
Configures settings for debugging the satellite daemon.
Syntax
debug satd
{
failed-refresh-timeout satellite gateway-refresh-time <value> name
<value> portal-refresh-time <value>
off |
on {debug | dump | normal} |
show |
statistics {all |reset}
}
Options
> failed-refresh-timeout Sets GlobalProtect satellite configuration failed refresh timeout
* gateway-refresh-time Time in minutes (0-10)
* name GlobalProtect satellite name
* portal-refresh-time Time in minutes (0-10)
> off Turns the debugging option off
> on Turns the debugging option on (option to specify debug, dump, or normal)
> show Shows whether this command is on or off
> statistics Shows or resets statistics counters
debug software
debug software
Configures software processes debugging features.
Syntax
debug software
{
core {device-server | l3-service | log-receiver | management-server | pancomm | rasmgr | routed | sslvpn-web-server | user-id | vardata-receiver
| web-server} |
fd-limit {limit <value> | service <value>} |
no-fd-limit service <value> |
no-virt-limit service <value> |t
restart {device-server | l3-service | log-receiver | management-server |
ntp | pan-comm | rasmgr | routed | snmpd | sslmgr | sslvpn-web-server |
user-id | vardata-receiver | web-server} |
trace {device-server | l3-service | log-receiver | management-server |
sslvpn-web-server | user-id | vardata-receiver | web-server} |
virt-limit {limit <value> | service <value>}
}
Options
> core Debugs process core
> device-server Device server process
> l3-service L3 services server process
> log-receiver Log Receiver server process
> management-server Management server process
> pan-comm Data plane communication process
> rasmgr SSL VPN daemon
> routed Routing process
> sslvpn-web-server SSL VPN Web server process
> user-id User ID process
> vardata-receiver Vardata Receiver server process
> web-server Web server process
> fd-limit Sets open fd limit (0-4294967295) and service value
> no-fd-limit Disables open fd limit service
> no-virt-limit Disables maximum virtual memory limit service
> restart Restarts processes
> device-server Device server process
> l3-service L3 services server process
> log-receiver Log Receiver server process
> management-server Management server process
> ntp Restart and re-synchronize NTP service
> pan-comm Data plane communication process
> rasmgr SSL VPN daemon
> routed Routing process
> satd Satellite daemon
> snmpd SNMP process
> sslmgr SSL manager daemon
> sslvpn-web-server SSL VPN Web server process
debug software
Sample Output
The following command restarts the web server.
admin@PA-HDF> debug software restart web-server
admin@PA-HDF>
debug ssl-vpn
debug ssl-vpn
Sets debugging options for the Secure Socket Layer (SSL)-virtual private network (VPN) web server.
Syntax
debug ssl-vpn
{
global |
{
off |
on {debug | dump | error | info} |
show
}
socket
}
Options
> global Turns debugging on or off at on the global level and shows debugging results (option to turn on debug,
dump, error, or info)
> socket Debugs on the socket level
Sample Output
The following command displays socket level information.
admin@PA-HDF> debug ssl-vpn socket
Proto Recv-Q Send-Q Local Address
Program name
tcp
0
0 0.0.0.0:20077
appweb
tcp
0
0 0.0.0.0:20088
appweb
Foreign Address
State
PID/
0.0.0.0:*
LISTEN
1674/
0.0.0.0:*
LISTEN
1674/
admin@PA-HDF>
debug sslmgr
debug sslmgr
Sets debugging options for the Secure Socket Layer (SSL) manager daemon that validates certificates
for the Certificate Revocation List (CRL) and the Online Certificate Status Protocol (OCSP). Each
trusted certificate authority (CA) maintains CRLs to determine if an SSL certificate is valid (not
revoked) for SSL decryption. The OCSP can also be used to dynamically check the revocation status of
a certificate.
Syntax
debug sslmgr
{
delete {crl | ocsp} {all | <value>} |
off |
on {debug | dump | error | info | warn} |
reset rsa-key |
save oscp |
set ocsp-next-update-time <value> |
show {ocsp-next-update-time | setting} |
statistics |
tar-all-crl |
view {crl <value> | ocsp {all | <value>}}
}
Options
> delete Removes the CRL/OCSP cache
> crl Delete CRL cache (all or specify CRL to delete)
> ocsp Delete OCSP cache (all or specify URL)
> off Turns the manager daemon off
> on Turns the manager daemon on (debug, dump, error, info, or warn)
> reset Resets the SSL decrypt key
> save Saves the contents of the OCSP cache
> set Sets the OCSP next update time, in minutes (1-10080)
> show Displays the SSL manager
> ocsp-next-update-time Shows the OCSP next update time
> setting Shows the debug setting
> statistics Displays the CRL/OCSP statistics
> tar-all-crl Saves all CRL files to a tar file
> view Displays the CRL/OCSP cache
> crl View CRL cache
> ocsp View OCSP cache (all or specify URL)
Sample Output
The following command displays the CRL cache.
admin@PA-HDF> debug sslmgr view crl
http://EVIntl-crl.verisign.com/EVIntl2006.crl
http://EVSecure-crl.verisign.com/EVSecure2006.crl
http://EVSecure-crl.verisign.com/pca3-g5.crl
http://SVRC3SecureSunMicrosystems-MPKI-crl.verisign.com/
debug sslmgr
SunMicrosystemsIncClassBUnified/LatestCRLSrv.crl
http://SVRIntl-crl.verisign.com/SVRIntl.crl
http://SVRSecure-crl.verisign.com/SVRSecure2005.crl
http://certificates.godaddy.com/repository/gdroot.crl
...
admin@PA-HDF>
debug swm
debug swm
Configures settings for debugging the Palo Alto Networks software manager.
Syntax
debug swm
{
history |
info {image <image_name>} |
install {image <image_name> | patch <value>} |
list |
log |
refresh content |
revert |
status |
unlock
}
Options
> history Shows history of software install operations
> info Displays info on current or specified image
> install Installs specified image and optional patch
> list Lists software versions available for install
> log Shows log of PAN Software Manager
> refresh Reverts back to last successfully installed content
> revert Reverts back to last successfully installed software
> status Shows status of PAN Software Manager
> unlock Unlocks PAN Software Manager
Sample Output
The following command shows the list of available software versions.
admin@PA-HDF> debug swm list
3.1.0-c4.dev
3.1.0-c1.dev_base
3.0.0-c207
3.0.0-c206
admin@PA-HDF>
debug system
debug system
Defines settings for system debugging actions.
Syntax
debug system
{
check-fragment |
disk-sync |
maintenance-mode |
ssh-key-reset {all | high-availability | management}
}
Options
> check-fragment Checks disk fragmentation
> disk-sync Flushes all writes out to disk
> maintenance-mode Reboots the system to maintenance mode
> ssh-key-reset Resets high availability and management SSH keys
Sample Output
The following command reboots the system to maintenance mode.
admin@PA-HDF> debug system maintenance-mode
admin@PA-HDF>
debug tac-login
debug tac-login
Configures settings for debugging the Palo Alto Networks Technical Assistance Center (TAC)
connection.
Syntax
debug tac-login {challenge | permanently-disable | response}
Options
> challenge Gets challenge value for TAC login
> permanently-disable Permanently turns off TAC login debugging
> response Runs verification of challenge response for TAC login
Sample Output
The following command turns TAC login debugging on.
admin@PA-HDF> debug tac-login on
admin@PA-HDF>
debug user-id
debug user-id
Configures settings for debugging user ID agents.
Syntax
debug user-id
{
agent <value> |
{
clear |
{
group-mapping {all | <value>} |
log
}
group-mapping <value> group {list | name <value>} |
off |
on {debug | error | info | verbose | warn} |
receive {no | yes} |
status
}
clear |
{
domain-map
gm-srvc-query {all | <value>} |
group {all | <value>} |
log
registered-ip
{
all |
ip <ip/netmask> |
vm-info-source {all | <name>}
}
}
dump |
{
com statistics |
domain-map |
edir-user {all | user <user_name>} |
ha |
hip-profile-database {start-from <value>} |
hip-report {computer <value> | ip <value> | user <value>} |
idmgr type |
{
high-availability state |
type
{
computer {all | id <value> | name <value>} |
gp-gateway {all | id <value> | name <value>} |
hip-object {all | id <value> | name <value>} |
hip-profile {all | id <value> | name <value>} |
user {all | id <value> | name <value>} |
debug user-id
debug user-id
Options
> agent Debugging commands for the specified user ID agent
> clear Clears agent data
> group-mapping Clears group mapping data on agent (all or specified group mapping)
> log Clears local agent debug logs
> group-mapping Shows proxied group mapping data on agent
* group Shows user groups data
> list Lists all groups on agent
> name Shows group's members on agent
> off Turns off agent debug logging
> on Turns on agent debug logging
debug Only output error, warning, info and debug logs
error Only output error logs
info Only output error, warning and info logs
verbose Output error, warning, info, debug and verbose logs
warn Only output error and warning logs
> receive Sets whether to receive log from agent
> status Displays agent status
> clear Clears data
> gm-srvc-query Clears group query in GM service
> group Clears data of specified group(s)
> log Clears debug logs
> registered-ip
> all Clears all register IP addresses
> ip Clears all registered IP addresses in the specified subnet
> vm-info-source Clears registered IP addresses monitored by one or all of the specified VM
information sources
> dump Dumps debug data
debug user-id
debug user-id
Sample Output
The following command displays the current debug logging setting.
username@hostname> debug user-id get
debug user-id
debug vardata-receiver
debug vardata-receiver
Configures settings for debugging the variable data daemon.
Syntax
debug vardata-receiver
{
off |
on {debug | dump | normal} |
set {all | third-party {all | libcurl}} |
show
statistics
unset {all | third-party {all | libcurl}}
}
Options
> off Turns the debugging option off
> on Turns the debugging option on (debug, dump, or normal)
> set Sets the variable data receiver (all, third party, libcurl)
> show Shows whether this command is on or off
> statistics Shows variable data daemon statistics
> unset Unsets the variable data receiver (all, third party, libcurl)
Sample Output
The following command shows statistics for the variable data daemon.
admin@PA-HDF> debug vardata-receiver statistics
admin@PA-HDF>
debug wildfire
debug wildfire
Configures settings for debugging the Wildfire services.
Syntax
debug wildfire
{
cloud-info set
{add-file-type <value> |
cloud-type <value> |
delete-file-type <value>} |
dp-status |
file-cache {disable | enable} |
file-digest sha256 <value> |
reset {all | dp-receiver | file-cache | forwarding | log-cache | report cache}
server-selection {enable | disable} |
}
Options
> cloud-info set
> add-file-type Specify type of file
> cloud-type Specify type of cloud
> delete-file-type Delete previously specified file type
> dp-status Displays the Wildfire DP status
> file-cache Enables or disables file caching
> file-digest Checks sample file
> reset Resets Wildfire services
> all Resets all Wildfire services
> dp-receiver Resets the Wildfire DP receiver
> file-cache Resets the Wildfire file cache
> forwarding Resets the Wildfire service connection
> log-cache Resets the Wildfire log cache
> report-cache Resets the Wildfire report cache
> server selection Enable or disable server selection
> transition-file-list Include transition file list
Sample Output
The following command displays the Wildfire DP status.
username@hostname> debug wildfire dp-status
DP status:
DP:
123.4.5.6:7890
username@hostname>
debug wildfire
delete
delete
Removes specified types of files from disk or restore the default comfort pages that are presented when
files or URLs are blocked.
Syntax
delete
{
admin-sessions |
anti-virus update <file_name> |
config |
{
repo device <device_name> {file <value> | running-config device
<value>} |
saved <file_name>
}
config-audit-history |
content |
{
cache |
{
curr-content type {aho-regex | all | decoder | dfa | sml | tdb}
version <value> |
old-content
}
update <file_name>
}
core {data-plane file <file_name> | management-plane file <file_name>} |
data-capture directory <directory_name> |
debug-filter file <file_name> |
dynamic-url host {all | name <value>} |
global-protect-client {image <file_name> | version <value>} |
high-availability-key |
hip-profile-database |
hip-report |
{
all |
report computer <value> ip <value> user <value>
}
license key <value> |
logo |
migration-log |
pcap directory <directory_name> |
policy-cache |
report |
{
custom scope <name> report-name <name> file-name <name> |
predefined scope <name> report-name <name> file-name <name> |
summary scope <name> report-name <name> file-name <name>
}
runtime-user-db |
software {image <file_name> | version <value>} |
delete
ssh-authentication-public-key |
sslmgr-store |
{
certificate-info {portal} |
{
db-serialno <value> |
name <value> |
serialno <value>
}
satellite-info {portal} |
{
name <value> |
serialno <value> |
state {assigned | unassigned}
}
satellite-info-revoke-certificate portal <value> {serialno <value>}
}
threat-pcap directory <directory_name> |
unknown-pcap directory <directory_name> |
url-database {all | url <value>} |
user-file ssh-known-hosts |
user-group-cache |
wildfire update <file_name>
}
Options
> admin-sessions Removes all active administrative sessions
> anti-virus Removes anti-virus updates on disk
> config Removes configuration files on disk
> repo Config repository
* device Device name
> file Named snapshot
> running-config Versioned running configuration
> saved Filename
> config-audit-history Removes the configuration audit history
> content Removes content images or cache on disk
> cache Removes cache files based
> curr-content Removes cache files based on Engine version and type
* type Type of content to be deleted
aho-regex Aho-regex cache
all All caches
decoder Decoder cache
dfa DFA cache
sml SML cache
tdb TDB cache
* version Content version to delete
> old-content Remove ALL old content
> update Filename to remove
> core Removes core management or data plane cores on disk
> data-capture Removes data capture files
> debug-filter Removes debugging packet capture files on disk
> dynamic-url Deletes the specified dynamic database(s) (for BrightCloud only)
> global-protect-client Removes GlobalProtect client software images on disk
> high-availability-key Removes the high availability peer encryption key
delete
Sample Output
The following command deletes the saved configuration file named running-config.xml.bak.
username@hostname> delete config saved running-config.xml.bak
username@hostname>
diff-all
diff-all
(Panorama only) Diffs shared policy and device configurations.
Syntax
diff-all
{
shared-policy |
{
device <value> |
include-template {no | yes} |
merge-with-candidate-cfg {no | yes} |
remove-overridden-objects {no | yes} |
vsys <value> |
device-group <value> |
num-context-lines <value>
}
template
{
merge-with-candidate-cfg {no | yes} |
remove-overridden-objects {no | yes} |
name <value> |
num-context-lines <value> |
device <value>
}
}
Options
> shared-policy Diff shared policies
+ device device name
+ include-template Whether to include relevant template
+ merge-with-candidate-cfg Whether to merge with candidate configuration
+ remove-overridden-objects Whether to remove overridden template objects on the device
+ vsys Virtual system name
* device-group Device group name
* num-context-lines Number of lines of context in the diff (0, 1, 10, 20, 5, all)
> template Diff templates
+ merge-with-candidate-cfg Whether to merge with device candidate configuration
+ remove-overridden-objects Whether to remove overridden objects on the device
* name Template name
* num-context-lines Number of lines of context in the diff (0, 1, 10, 20, 5, all)
> device Device name or list of names enclosed in [ ]
exit
exit
Exits the PAN-OS CLI.
Note: The exit command is the same as the quit command.
Syntax
exit
Options
None
find
find
Lists CLI commands containing the specified keyword.
Syntax
find command keyword <value>
Options
<value> Specifies a keyword.
Sample Output
The following command lists all CLI commands containing the keyword hsm.
username@hostname# find command keyword hsm
set profiles decryption <name> ssl-inbound-proxy block-if-hsm-unavailable
{yes | no}
set profiles decryption <name> ssl-forward-proxy block-if-hsm-unavailable
{yes | no}
username@hostname#
ftp
ftp
Uses FTP to export log files. The logs that may be exported are data, threat, traffic or URL logs.
Syntax
ftp export log {data | threat | traffic | url} end-time equal <value> starttime equal <value> to <value>
{
max-log-count <value> |
passive-mode equal {no | yes} |
query <value> |
remote-port <port_number> |
unexported-only equal {no | yes}
}
Options
+ max-log-count Maximum number of logs to export (0-65535)
+ passive-mode Use ftp passive mode
+ query Query value
+ remote-port FTP port number on remote host (1-65535)
+ unexported-only Filter logs that are not previously exported
* end-time End date and time YYYY/MM/DD@hh:mm:ss (e.g. 2006/08/01@10:00:00)
* start-time Start date and time YYYY/MM/DD@hh:mm:ss (e.g. 2006/08/01@10:00:00)
* to Destination (username:password@host) or (username@host)
grep
grep
Finds and lists lines from log files that match a specified pattern.
Syntax
grep pattern <value>
{
after-context <number> |
before-context <number> |
context <number> |
count |
ignore-case {no | yes} |
invert-match {no | yes} |
line-number {no | yes} |
max-count <number> |
no-filename {no | yes} |
dp-log <file_name> |
mp-log <file_name>
}
Options
+ after-context Prints the matching lines plus the specified number of lines that follow the matching lines
+ before-context Prints the matching lines plus the specified number of lines that precede the matching lines
+ context Prints the specified number of lines in the file for output context
+ count Specifies whether a count is included in the results
+ ignore-case Ignores case distinctions
+ invert-match Selects non-matching lines instead of matching lines
+ line-number Adds the line number at the beginning of each line of output
+ max-count Stops reading a file after the specified number of matching lines
+ no-filename Does not add the filename prefix for output
* pattern Indicates the string to be matched
> dp-log Indicates the data plane log file to search for the pattern (press <tab> for a list of file names)
> mp-log Indicates the management plane log file to search for the pattern (press <tab> for a list of file names)
Sample Output
The following command searches the brdagent.log file for occurrences of the string HEARTBEAT.
username@hostname> grep dp-log sysdagent.log
*
Jan 20 14:35:48 HEARTBEAT: Heartbeat failure
Jan 20 14:35:53 HEARTBEAT: Heartbeat failure
Jan 20 14:35:54 HEARTBEAT: Heartbeat failure
Jan 20 14:35:55 HEARTBEAT: Heartbeat failure
username@hostname>
pattern HEARTBEAT
on
on
on
on
core
core
core
core
4
1
8
2
less
less
Lists the contents of the specified log file.
Note: The dp-log option will not be available on devices that do not have a dataplane, such as the PA200.
Syntax
less
{
agent-log <value> |
custom-page <filename> |
dp-backtrace <filename> |
dp-log <filename> |
mp-backtrace <filename> |
mp-global <filename> |
mp-log <filename> |
webserver-log <filename>
}
Options
> agent-log Lists contents of the specified agent log directory (press <tab> for a list of log directories)
> custom-page Lists contents of the specified custom page file (press <tab> for a list of log files)
> dp-backtrace Lists contents of the specified data plane backtrace file (press <tab> for a list of log files)
> dp-log Lists contents of the specified data plane log file (press <tab> for a list of log files)
> mp-backtrace Lists contents of the specified management plane backtrace file (press <tab> for a list of log
files)
> mp-global Lists contents of the specified management plane global log file (press <tab> for a list of log files)
> mp-log Lists contents of the specified management plane log file (press <tab> for a list of log files)
> webserver-log Lists contents of the specified webserver log file (press <tab> for a list of log files)
Sample Output
The following command lists the contents of the web server error log.
username@hostname>
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
...
ls
ls
Displays debug file listings.
Syntax
ls
{
long-format {no | yes} |
reverse-order {no | yes} |
sort-by-time {no | yes} |
content {apps | cache | decoders | global | pan_appversion |
pan_threatversion | scripts | threats | <content>} |
custom-page <value> |
dp-backtrace <filename> |
dp-log <filename> |
global <filename> |
mp-backtrace <filename> |
mp-global <filename> |
mp-log <filename> |
webserver-log <filename>
}
Options
+ long-format File listing format (use long format)
+ reverse-order File listing order (list in reverse order)
+ sort-by-time Sort file listing by time
> content Specify content to display
> custom-page Custom page (select value from the list provided; press <tab> for list)
> dp-backtrace DP backtrace file (select file from the list provided; press <tab> for list)
> dp-log DP logs (select file from the list provided; press <tab> for list)
> global Global files (select file from the list provided; press <tab> for list)
> mp-backtrace MP backtrace file (select file from the list provided; press <tab> for list)
> mp-global MP global files (select file from the list provided; press <tab> for list)
> mp-log MP logs (select file from the list provided; press <tab> for list)
> webserver-log Web server logs (select file from the list provided; press <tab> for list)
netstat
netstat
Displays network connections and statistics.
Syntax
netstat
{
all {no | yes} |
cache {no | yes} |
continuous {no | yes} |
extend {no | yes} |
fib {no | yes} |
groups {no | yes} |
interfaces {no | yes} |
listening {no | yes} |
numeric {no | yes} |
numeric-hosts {no | yes} |
numeric-ports
numeric-users {no | yes} |
programs {no | yes} |
route {no | yes} |
statistics {no | yes} |
symbolic {no | yes} |
timers {no | yes} |
verbose {no | yes}
}
Options
+ all Display all sockets (default = connected)
+ cache Display routing cache instead of Forwarding Information Base (FIB)
+ continuous Continuous listing
+ extend Display other/more information
+ fib Display FIB (default)
+ groups Display multicast group memberships
+ interfaces Display interface table
+ listening Display listening server sockets
+ numeric Do not resolve names
+ numeric-hosts Do not resolve host names
+ numeric-ports Do not resolve port names
+ numeric-users Do not resolve user names
+ programs Display PID/Program name for sockets
+ route Display routing table
+ statistics Display networking statistics (like SNMP)
+ symbolic Resolve hardware names
+ timers Display timers
+ verbose Display full details
netstat
Sample Output
The following command shows an excerpt from the output of the netstat command.
username@hostname> netstat all yes
...
Active UNIX domain sockets (servers and established)
Proto RefCnt Flags
Type
State
I-Node Path
unix 2
[ ACC ]
STREAM
LISTENING
5366
/tmp/ssh-lClRtS1936/
agent.1936
unix 2
[ ]
DGRAM
959
@/org/kernel/udev/udevd
unix 18
[ ]
DGRAM
4465
/dev/log
...
ping
ping
Checks network connectivity to a host.
Syntax
ping host <value>
{
bypass-routing {no | yes} |
count <value> |
do-not-fragment {no | yes} |
inet6 {no | yes} |
interval <value> |
no-resolve {no | yes} |
pattern <value> |
size <value> |
source <value> |
tos <value> |
ttl <value> |
verbose {no | yes}
}
Options
> bypass-routing Sends the ping request directly to the host on a direct attached network, bypassing usual
routing table
> count Specifies the number of ping requests to be sent (1-2,000,000,000)
> do-not-fragment Prevents packet fragmentation by use of the do-not-fragment bit in the packets IP header
> inet6 Specifies that the ping packets will use IP version 6
> interval Specifies how often the ping packets are sent (0 to 2000000000 seconds)
> no-resolve Provides IP address only without resolving to hostnames
> pattern Specifies a custom string to include in the ping request (you can specify up to 12 padding bytes to fill
out the packet that is sent as an aid in diagnosing data-dependent problems)
> size Specifies the size of the ping packets (0-65468 bytes)
> source Specifies the source IP address for the ping command
> tos Specifies the type of service (TOS) treatment for the packets by way of the TOS bit for the IP header in the
ping packet (1-255)
> ttl Specifies the time-to-live (TTL) value for the ping packet (IPv6 hop-limit value) (0-255 hops)
> verbose Requests complete details of the ping request.
* host Specifies the host name or IP address of the remote host
ping
Sample Output
The following command checks network connectivity to the host 66.102.7.104, specifying 4 ping
packets and complete details of the transmission.
username@hostname> ping count 4 verbose yes host 66.102.7.104
PING 66.102.7.104 (66.102.7.104) 56(84) bytes of data.
64 bytes from 66.102.7.104: icmp_seq=0 ttl=243 time=316 ms
64 bytes from 66.102.7.104: icmp_seq=1 ttl=243 time=476 ms
64 bytes from 66.102.7.104: icmp_seq=2 ttl=243 time=376 ms
64 bytes from 66.102.7.104: icmp_seq=3 ttl=243 time=201 ms
--- 66.102.7.104 ping statistics --4 packets transmitted, 4 received, 0% packet loss, time 3023ms
rtt min/avg/max/mdev = 201.718/342.816/476.595/99.521 ms, pipe 2
username@hostname>
quit
quit
Exits the current session for the firewall.
Note: The quit command is the same as the exit command.
Syntax
quit
Options
None
request acknowledge
request acknowledge
Acknowledges alarm logs.
Syntax
request acknowledge logid <value>
Options
<value> Specifies the log ID
request analyze-shared-policy
request analyze-shared-policy
(Panorama only) Displays shadowed object analysis.
Syntax
request analyze-shared-policy
Options
None.
request anti-virus
request anti-virus
Upgrade and downgrade antivirus packages and obtain information about the packages.
Syntax
request anti-virus
{
downgrade install <value> |
upgrade
{
check |
download latest {sync-to-peer {no | yes}} |
info |
install
{
commit {no | yes} |
sync-to-peer {no | yes} |
file <filename> |
version latest
}
}
}
Options
> downgrade Installs a previous version
> upgrade Performs anti-virus upgrade functions
> check Obtains information on available packages from the Palo Alto Networks server
> download Downloads anti-virus packages
+ sync-to-peer Sends a copy to HA peer
> info Shows information about available anti-virus packages
> install Installs anti-virus packages
+ commit Indicates whether the installed package will be committed to the firewall
+ sync-to-peer Indicates whether a copy of the package will be provided to another high-availability
peer firewall
> file Specifies the name of the file containing the anti-virus package
> version Specifies the latest version of the anti-virus software package
Sample Output
The following command displays information on the anti-virus packages that are available for
installation.
username@hostname> request anti-virus upgrade info
Version
Size
Released on Downloaded
------------------------------------------------------------------------46-93
44MB 2009/11/19 11:50:38
yes
username@hostname>
request anti-virus
request batch
request batch
(Panorama only) Performs operations on groups of devices.
Syntax
request batch
{
anti-virus |
{
check |
delete <value> |
download <value> |
eligible {file | uploaded-files} <value> |
info |
upload-install
{
devices <value> |
file <value> |
log-collector <value> |
uploaded-file <value>
}
}
content |
{
check |
delete <value> |
download <value> |
eligible {file | uploaded-files} <value> |
info |
upload-install
{
devices <value> |
file <value> |
log-collector <value> |
uploaded-file <value>
}
}
global-protect-client |
{
activate devices <value> {file | uploaded-file} <value> |
check |
delete <value> |
download <value> |
eligible {file | uploaded-files} <value> |
info |
upload devices <value> {file | uploaded-file} <value> |
upload-activate devices <value> {file | uploaded-file} <value>
}
license |
{
activate authcodes <value> devices <value> |
request batch
info |
refresh <value>
}
reboot |
{
devices <value> |
log-collector <value>
}
software |
{
check |
delete <value> |
download <value> |
eligible {file | uploaded-files} <value> |
info |
install |
{
devices <value> |
file <value> |
log-collector <value> |
uploaded-file <value>
}
upload |
{
devices <value> |
file <value> |
log-collector <value> |
uploaded-file <value>
}
upload-install
{
reboot {no | yes} |
devices <value> |
file <value> |
log-collector <value> |
uploaded-file <value>
}
}
url-filtering |
{
check |
delete <value> |
download <value> |
eligible {file | uploaded-files} <value> |
info |
upload |
{
devices <value> |
file <value> |
log-collector <value> |
uploaded-file <value>
}
upload-install
{
request batch
Options
> anti-virus Performs antivirus package operations
> check Checks for available antivirus package versions
> delete Deletes a given antivirus package
> download Downloads antivirus packages to Panorama
> eligible Gets a list of devices eligible for a given antivirus package
> file File containing list of eligible devices
> uploaded-file Uploaded file name
> info Displays available antivirus packages on Panorama
> upload-install Uploads and installs an antivirus package
> devices List of devices to upload package onto
> file Antivirus package filename
> log-collector List of log-collectors to upload package onto
> uploaded-file Antivirus package filename
> content Performs content operations
> check Checks for available content versions
> delete Deletes a given content package
request batch
request batch
request batch
request certificate
request certificate
Generate a self-signed security certificate.
Syntax
request certificate
{
generate certificate-name <value> name <value> |
{
ca {no | yes} |
country-code <value> |
days-till-expiry <value> |
digest <value> |
email <value> |
filename <value> |
locality <value> |
nbits <value> |
ocsp-responder-url <value> |
organization <value> |
signed-by <value> |
state <value> |
passphrase <value> |
alt-email <value> |
hostname <value> |
ip <ip/netmask> |
organization-unit <value>
}
renew certificate-name <value> {days-till-expiry <value>} |
revoke {certificate-name <value> | sslmgr-store db-serialno <value>
}
Options
> generate Generate certificate
+ ca Make this a signing certificate
+ country-code Two-character code for the country in which the certificate will be used
+ days-till-expiry Number of days until expiry (1-7300)
+ digest Digest Algorithm (md5, sh1, sha256, sha384, sha512)
+ email Email address of the contact person
+ filename File name for the certificate
+ locality Locality (city, campus, or other local area)
+ nbits Length of the key (number of bits in the certificate 1024, 15360, 2048, 3072, 512)
+ organization Organization using the certificate
+ signed-by CA for the signing certificate
+ state Two-character code for the state or province in which the certificate will be used
* certificate-name Name of the certificate object
* name IP address or fully qualified domain name (FQDN) to appear on the certificate
> alt-email Subject alternate email type (value or list of values enclosed in [ ])
> hostname Subject alternate name DNS type (value or list of values enclosed in [ ])
> ip Subject alternate name IP type (IP address and network mask; value or list of values enclosed in [ ])
> organization-unit Department using the certificate (value or list of values enclosed in [ ])
request certificate
Sample Output
The following command requests a self-signed certificate for the web interface with length 1024 and IP
address 1.1.1.1.
username@hostname> request certificate self-signed nbits 1024 name 1.1.1.1
for-use-by web-interface
username@hostname>
request chassis
request chassis
Use chassis control commands.
Syntax
request chassis
{
admin-power-off slot <value> target <value> {now | time-to-wait <value>} |
admin-power-on slot <value> target <value> |
enable slot <value> target <value> |
power-off slot <value> target <value> {now | time-to-wait <value>} |
power-on slot <value> target <value> |
restart slot <value> target <value> |
}
Options
> admin-power-off Power off a slot and keep powered down across reboots and card events - specify slot, target
(whether to perform operation locally (default) or on the HA peer device as well), and timing
> admin-power-on Power on a slot even if in admin power down mode - specify slot, target (whether to perform
operation locally (default) or on the HA peer device as well)
> enableEnable slot for traffic - specify slot and target (whether to perform operation locally (default) or on the
HA peer device as well)
> power-off Power off a slot - specify slot, target (whether to perform operation locally (default) or on the HA
peer device as well), and timing
> power-on Power on a slot - specify slot, target (whether to perform operation locally (default) or on the HA
peer device as well)
> restartRestart slot - specify slot and target (whether to perform operation locally (default) or on the HA peer
device as well)
request commit-lock
request commit-lock
Sets options for locking commits.
Syntax
request commit-lock
{
add {comment <value>} |
remove {admin <value>}
}
Options
> add Prevents other users from committing
+ comment Comment value
> remove Releases commit lock previously held
+ admin Administrator holding the lock
request config-backup
request config-backup
(Panorama only) Sets device configuration backups.
Syntax
request config-lock device <value>
{
file <value> |
running-config <value>
}
Options
* device Device name
> file Named snapshot
> running-config Versioned running config
request config-lock
request config-lock
Sets options for locking configurations.
Syntax
request config-lock {add {comment <value>} | remove}
Options
> add Prevents other users from changing the configuration
> remove Releases a previously held configuration lock
request content
request content
Perform application level upgrade operations.
Syntax
request content
{
downgrade install {<value> |
upgrade
{
check |
download latest {sync-to-peer {no | yes}} |
info |
install
{
commit {no | yes} |
sync-to-peer {no | yes} |
file <filename> |
version latest
}
}
}
Options
> downgrade Installs a previous content version
> upgrade Performs content upgrade functions
> check Obtains information on available packages from the Palo Alto Networks server
> download Downloads content packages
+ sync-to-peer Sends a copy to HA peer
> info Shows information about available content packages
> install Installs content packages
+ commit Indicates whether the installed package will be committed to the firewall
+ sync-to-peer Indicates whether a copy of the package will be provided to another high-availability
peer firewall
> file Specifies the name of the file containing the content package
> version Specifies the latest version of the content software package
Sample Output
The following command lists information about the firewall server software.
username@hostname> request content upgrade check
Version
Size
Released on Downloaded
------------------------------------------------------------------------13-25
10MB 2007/04/19 15:25:02
yes
username@hostname>
request content
request data-filtering
request data-filtering
Assign passwords for data filtering.
Syntax
request data-filtering access-password
{
create password <value> |
delete |
modify new-password <value> old-password <value>
}
Options
> create Creates the specified password
> delete Deletes the data filtering password (when this command is issued, the system prompts for confirmation
and warns that logged data will be deleted and logging will be stopped)
> modify Changes the specified old password to the new password
Sample Output
The following command assigns the specified password for data filtering.
username@hostname> request data-filtering access-password create password
mypwd
username@hostname>
request device-registration
request device-registration
Performs device registration.
Syntax
request device-registration password <pwd> username <user>
Options
* password Specifies the support portal password for device access
* username Specifies the support portal user name for device access
Sample Output
The following command registers the device with the specified user name and password.
username@hostname> request device-registration username admin password
adminpwd
username@hostname>
request dhcp
request dhcp
Manages the Dynamic Host Configuration Protocol (DHCP) leases with specified client interfaces.
Syntax
request dhcp client
{
release {all | vlan | <value>} |
renew {all | vlan | <value>}
}
Options
> release Interface name to release DHCP lease on (all, VLAN, or interface name)
> renew Interface name to renew DHCP lease on (all, VLAN, or interface name)
Sample Output
The following command releases the specified interface from its DHCP lease.
username@hostname> request dhcp client release ethernet1
username@hostname>
request global-protect-client
request global-protect-client
Performs GlobalProtect client package operations.
Syntax
request global-protect-client software
{
activate {file <file_name> | version <value>} |
check |
download |
{
sync-to-peer {no | yes} |
file <file_name> |
version <value>
}
info
}
Options
> activate Activates a downloaded software package
> file Upgrades to a software package by filename (press <tab> for list)
> version Upgrades to a software package by version (press <tab> for list)
> check Gets information from Palo Alto Networks server
> download Downloads software packages
+ sync-to-peer Sends a copy to HA peer
> file Downloaded software packages by filename (press <tab> for list)
> version Download software packages by version (press <tab> for list)
> info Shows information about available software packages
request global-protect-gateway
request global-protect-gateway
Requests performance of GlobalProtect gateway functions.
Syntax
request global-protect-gateway
{
client-logout gateway <value> reason force-logout user <value> |
{
computer <value> |
domain <value>
}
satellite-logout gateway <value> reason force-logout serialno <value> |
unlock auth-profile <value> user <value> vsys <value> {is-seq {no | yes}}
}
Options
> client-logout GlobalProtect gateway user logout
+ computer User's computer name
+ domain User's domain name
* gateway Name of the GlobalProtect gateway remote user tunnel name
* reason Reason for logout (force)
* user User name
> satellite-logout GlobalProtect gateway satellite logout
* gateway Name of the GlobalProtect gateway site-to-site tunnel name
* reason Reason for logout (force)
* serialno Device serial number
> unlock Unlock locked users
+ is-seq Is this authentication sequence?
* auth-profile Auth Profile
* user User name
* vsys Virtual System
request global-protect-portal
request global-protect-portal
Requests performance of GlobalProtect portal functions.
Syntax
request global-protect-portal ticket duration <value> portal <value> request
<value>
Options
* duration Agent user override duration in minutes (0-65535)
* portal Name of the GlobalProtect portal
* request Request string in format ^[0-9A-F]{4}-[0-9A-F]{4}$
request global-protect-satellite
request global-protect-satellite
Requests performance of GlobalProtect satellite functions.
Syntax
request global-protect-satellite
{
get gateway-config gateway-address <value> satellite <value> |
get-portal-config satellite <value>
{
password <value> |
username <value>
}
}
Options
> get-gateway-config GlobalProtect satellite get config from gateway
* gateway-address GlobalProtect gateway address
* satellite GlobalProtect satellite
> get-portal-config GlobalProtect satellite get config from portal
+ password Password to login into GlobalProtect portal
+ username User name to login into GlobalProtect portal
* satellite GlobalProtect satellite
request high-availability
request high-availability
Performs high-availability operations.
Syntax
request high-availability
{
state {functional | suspend} |
sync-to-remote
{
candidate-config |
clock |
id-manager {base | user-id} |
running-config |
runtime-state
}
}
Options
> state Sets the HA state of the device
> functional Enables the HA state
> suspend Sets the HA state to suspended
> sync-to-remote Performs configuration sync operations
> candidate-config Syncs candidate configuration to peer
> clock Syncs the local time and date to the peer
> id-manager Syncs ID manager to peer
> base Syncs the base id manager to the peer
> user-id Syncs the user id manager to the peer
> running-config Syncs running configuration to peer
> runtime-state Syncs the runtime synchronization state to peer
Sample Output
The following command sets the high-availability state of the device to the suspended state.
username@hostname> request high-availability state suspend
username@hostname>
request hsm
request hsm
Performs Hardware Security Module (HSM) operations.
Syntax
request hsm
{
authenticate password <password> server <name> |
ha {create-ha-group password <password> | recover | replace-server
password <password> | synchronize password <password>} |
login <password> |
mkey-wrapping-key-rotation |
reset |
rfs-setup |
rfs-sync |
server-enroll <value> |
support-into
}
Options
> authenticate HSM server name (specify password)
> ha HSM HA setup
> create-ha-group HSM create HA group (specify password)
> recover Recovery
> replace-server Replace one HSM server in the HA group (specify password)
> synchronize HSM synchronize the contents of members of the HA group (specify password)
> login Specify password for login
> mkey-wrapping-key-rotation Encrypt the master key with a new wrapping key on HSM
> reset Clean up HSM client side data: cert, key files, cache, and so on
> rfs-setup Set up RFS
> rfs-sync Get update from RF
> server-enroll Specify HSM server name
> support-info Create HSM support info. Valid only for Luna SA
Sample Output
The following command sets the high-availability state of the device to the suspended state.
username@hostname> request high-availability state suspend
username@hostname>
request last-acknowledge-time
request last-acknowledge-time
Displays the last alarm acknowledgement time.
Syntax
request last-acknowledge-time
Options
None
Sample Output
The following command provides the last alarm acknowledgement time.
username@hostname> request last-acknowledge-time
0
username@hostname>
request license
request license
Performs license-related operations.
Syntax
request license {fetch <auth-code> | info | install}
Options
> fetch Gets a new license key using an authentication code
+ auth-code Specifies the authentication code to use in fetching the license
> info Displays information about currently owned licenses
> install Installs a license key
Sample Output
The following command requests a new license key with the authentication code 123456.
request log-fwd-ctrl
request log-fwd-ctrl
Controls device log forwarding.
Syntax
request log-fwd-ctrl action {live | start | start-from-lastack | stop} device
<value>
Options
* action Start or stop log forwarding
live Start log forwarding with no buffering
start Start log forwarding with buffering
start-from-lastack Start log forwarding with buffering, starting from last ack'ed logid
stop Stop log forwarding
* device Serial number of device
request master-key
request master-key
Changes the master key.
Syntax
request master-key lifetime <value> new-master-key <value>
{
current-master-key <value> |
reminder <value> |
}
Options
+ on-hsm Encrypt the master key on hardware security module (HSM) (yes or no, default is no)
+ current-master-key Specifies the current master key (64-bit encoded public key)
+ reminder When to send expiry reminder, in hours (1-8760)
* lifetime Lifetime of the new key, in hours (1-17520)
* new-master-key Specifies a new master key (64-bit encoded public key)
request password-change-history
request password-change-history
Displays the history of the user password and re-encrypts it.
Syntax
request password-change-history
{
dump-history {master-key <value>} |
re-encrypt old-master-key <value> {master-key <value>}
}
Options
> dump-history Dumps contents of password history
+ master-key Master key used to encrypt passwords
> re-encrypt Re-encrypts password
+ master-key Masterkey to encrypt historical passwords
* old-master-key Old masterkey used to encrypt historical passwords
request password-hash
request password-hash
Generates a hashed string for the user password.
Syntax
request password-hash password <pwd>
Options
password Specifies the plain text password that requires the hash string
Sample Output
The following command generates a hash of the specified password.
username@hostname> request password-hash password mypassword
$1$flhvdype$qupuRAx4SWWuZcjhxn0ED.
request push-report-definitions
request push-report-definitions
(Panorama only) Requests that report definitions are pushed to devices.
Syntax
request push-report-definitions
Options
None
Sample Output
The following command pushes report definitions to the Panorama managed devices.
username@hostname> request push-report-definitions
request quota-enforcement
request quota-enforcement
Enforces disk quotas for logs and packet captures.
Syntax
request quota-enforcement
Options
None
Sample Output
The following command enforces the disk quotas.
username@hostname> request quota-enforcement
request restart
request restart
Restarts the system or software modules.
CAUTION: Using this command causes the firewall to reboot, resulting in the
temporary disruption of network traffic. Unsaved or uncommitted changes will be
lost.
Syntax
request restart {dataplane | software | system}
Options
> dataplane Restarts the data plane software
> software Restarts all system software
> system Reboots the system
Sample Output
The following command restarts all the firewall software.
username@hostname> request restart software
request shutdown
request shutdown
Performs a clean shutdown of the system.
CAUTION: Using this command causes the firewall to shut down, and network
traffic will be disrupted. In addition, unsaved or uncommitted changes will be lost.
Syntax
request shutdown system
Options
None
Sample Output
The following command shuts down the firewall.
username@hostname> request shutdown system
request stats
request stats
Generates a dump of the statistics.
Syntax
request stats dump
Options
None
Sample Output
The following command orders a statistics dump.
username@hostname> request stats dump
Exec job enqueued with jobid 56
56
username@hostname>
request support
request support
Obtains technical support information.
Syntax
request support {check | info}
Options
> check Gets support information from the Palo Alto Networks update server
> info Shows downloaded support information
Sample Output
The following command shows downloaded support information.
username@hostname> request support info
0
Support Home
https://support.paloaltonetworks.com
Manage Cases
https://support.paloaltonetworks.com/pa-portal/
index.php?option=com_pan&task=vie
wcases&Itemid=100
Download User Identification Agent
https://support.paloaltonetworks.com/pa-portal/
index.php?option=com_pan&task=sw_
updates&Itemid=135
866-898-9087
[email protected]
November 07, 2009
Standard
10 x 5 phone support; repair and replace hardware service
username@hostname>
request system
request system
Performs system functions, including self testing, downloading system software, and requesting
information about the available software packages.
Syntax
request system
{
external-list |
{
refresh name <value> vsys <value> |
show name <value> vsys <value> |
url-test <value>
}
fqdn {refresh {force {no | yes}} | show} |
private-data-reset |
raid
{
slot <value> add <drive> force no-format |
slot <value> copy from <drive> to <drive> |
slot <value> remove <drive>
}
self-test |
{
crypto |
force-crypto-failure {dp <value> | mp <value>} |
software-integrity
}
self-test-job {crypto | software-integrity} |
software
{
check |
download {sync-to-peer {no | yes} | file <file> | version <version>} |
info |
install {load-config <value> | file <file> | version <version>}
}
}
Options
> external-list Performs external-list refresh/sanity functions
> refresh Refreshes external-lists
* name Name of list
* vsys Virtual system
> show Prints IPs in an external list
* name Name of list
* vsys Virtual system
> url-test Test accessibility for URL
> fqdn Performs FQDN refresh/reset functions
> refresh Force-refreshes all FQDNs used in rules (option to force)
> show Displays FQDNs used in rules and their IP addresses
request system
> private-data-reset Removes all of the logs and resets the configuration but does not reset content and software
versions
> raid Perform operations on RAID (add drive to array, copy and migrate one drive to another in the bay, or
remove a drive from the bay)
> self-test This option is available in Common Criteria (CC) mode and Federal Information Processing Standard
140-2 (FIPS 140-2) mode (for more information, refer to Chapter 6, Maintenance Mode)
> crypto Performs a self-test on all of the cryptographic algorithms the system has on it; if a failure occurs,
the system will go into maintenance mode
> force-crypto-failure Causes the system to reboot and fail the specified cryptographic self-test when it
reboots; if a failure occurs, the system will go into maintenance mode
> dp Fail test on data plane
> mp Fail test on management plane
> software-integrity Performs a software integrity test; if a failure occurs, the system will go into
maintenance mode
> self-test-job Runs FIPS/CC self-test jobs
> crypto Runs crypto self-test job
> software-integrity Runs software integrity self-test job
> software Performs system software installation functions
> check Gets information from Palo Alto Networks server
> download Downloads software packages
+ sync-to-peer Sends a copy to HA peer
> file Downloads software packages by filename
> version Downloads software packages by version
> info Shows information about available software packages
> install Installs a downloaded software package
+ load-config Configuration to use for booting new software
> file Upgrades to a software package by filename
> version Upgrades to a software package by version
Sample Output
The following command requests information about the software packages that are available for
download.
username@hostname> request system software info
Version
Filename
Size
Released Downloaded
------------------------------------------------------------------------3.0.1
panos.4050-3.0.1.tar.gz
127MB 2010/02/07 00:00:00
no
3.1.0
panos.4050-3.1.0.tar.gz
127MB 2009/02/07 00:00:00
no
username@hostname>
request tech-support
request tech-support
Obtains information to assist technical support in troubleshooting.
Syntax
request technical support dump
Options
None
Sample Output
The following command creates a dump for technical support.
username@hostname> request tech-support dump
Exec job enqueued with jobid 1
1
username@hostname>
request url-filtering
request url-filtering
Performs URL filtering operations.
Syntax
request url-filtering
{
download |
{
paloaltonetworks {region <value>} |
status vendor {brightcloud | paloaltonetworks}
}
install |
{
database major-version <value> md5 <value> minor-version <value> |
signed-database
}
revert |
save url-database |
update url <value> |
upgrade {brightcloud {test}}
}
Options
> download Shows download information for URL filtering
> paloaltonetworks Downloads seed database for Palo Alto Networks URL filtering (option to specify
APAC, Japan, North America, or other region) (for the Palo Alto Networks URL filtering database only)
> status Displays the URL database download status (specify BrightCloud or Palo Alto Networks vendor)
> install Installs uploaded URL database
> database Installs uploaded BrightCloud database (for BrightCloud only)
* major-version Major BrightCloud database version
* md5 MD5 of BrightCloud database
* minor-version Minor BrightCloud database version
> signed-database Installs signed uploaded BrightCloud database
> revert Reverts last URL database (for BrightCloud only)
> save Saves the Palo Alto Networks URL database cache in the management plane (for the Palo Alto Networks
URL filtering database only)
> update Updates the specified URL category from the cloud (for the Palo Alto Networks URL filtering database
only)
> upgrade Upgrades to latest version (for BrightCloud only)
+ brightcloud Upgrades BrightCloud database (where present)
+ test Captures initial download in filter-pcap test_bc_download.pcap
Sample Output
The following command upgrades the BrightCloud database.
username@hostname> request url-filtering upgrade brightcloud
request url-filtering
The following command downloads the North American seed database for the Palo Alto Networks
URL filtering database.
username@hostname> request url-filtering download paloaltonetworks region
North-America
request wildfire
request wildfire
Performs Wildfire maintenance operations.
For more information on WildFire, refer to the WildFire Administrators Guide.
Syntax
request wildfire
{
downgrade install <value> |
registration |
upgrade
{
check |
download latest {sync-to-peer {no | yes} |
info |
install
{
commit {no | yes} |
sync-to-peer {no | yes} |
file <value> |
version latest
}
}
}
Options
> downgrade Performs Wildfire downgrade functions (installs Wildfire packages)
> registration Performs Wildfire registration
> upgrade Performs Wildfire upgrade functions
> check Gets information from Palo Alto Networks server
> download Downloads Wildfire packages
+ sync-to-peer Sends a copy to HA peer
> info Shows information about available Wildfire packages
> install Installs Wildfire packages
+ commit Skips commit after installing Wildfire
+ sync-to-peer Sends a copy to HA peer
> file Installs imported Wildfire package
> version Installs latest version
schedule
schedule
Schedules botnet and UAR reports.
Syntax
schedule
{
botnet-report topn <value> |
{
period {last-24-hrs | last-calendar-day} |
query <value>
}
dlc-query dir {bkwd | fwd} nlogs <value> type <value> |
{
count-only {no | yes} |
csv {no | yes} |
ini_only {no | yes} |
query <value>
}
uar-report user <username>
{
end-time <value> |
period <value> |
skip-detailed-browsing {no | yes} |
start-time <value> |
title <value>
user <value> |
user-group <value> |
vsys <value> |
}
}
Options
> botnet-report Schedule botnet report
+ period Report period (last 24 hours or last calendar day)
+ query Query value
* topn TopN value (1-500)
> dlc-query Schedule a DLC query
+ count-only Report the count only
+ csv Use Comma Separated Values (CSV) format
+ init_only Report to include inits only
+ query Query value
* dir Query direction (backward or forward)
* nlogs NLogs value (1-100)
* type Query type
> uar-report Schedule user access UAR report
+ end-time Report end time
+ period Period to be covered in report
+ skip-detailed-browsing (no or yes)
+ start-time Report start time
schedule
scp export
scp export
Uses SCP (secure copy) to upload files from the device to another system. Use this command to copy
files between the firewall and another host.
Syntax
scp export <option> to <target> {remote-port <port_number> | source-ip
<ip_address>}
{
application-block-page |
application-pcap from <file_name> |
captive-portal-text |
configuration from <file_name> |
core-file {data-plane | management-plane} from <file_name> |
crl from <file_name> |
debug-pcap from <file_name> |
device-state |
file-block-continue-page |
file-block-page |
filter-pcap from <file_name> |
global-protect-portal-custom-help-page name <file_name> |
global-protect-portal-custom-login-page name <file_name> |
global-protect-portal-custom-welcome-page name <file_name> |
high-availability-key from <file_name> |
inbound-proxy-key from <value> |
log {data | threat | traffic | url} end-time equal <value> start-time
equal <value> |
{
max-log-count <value> |
query <value> |
unexported-only equal {no | yes}
}
log-file {data-plane | management-plane} |
logdb |
mgmt-pcap from <file_name> |
pan-url-db |
pdf-reports from <file_name> |
ssl-cert-status-page |
ssl-optout-text |
stats-dump {end-time equal <value> | start-time equal <value>} |
tech-support |
threat-pcap from <file_name> |
url-block-page |
url-coach-text |
virus-block-page |
web-interface-certificate
}
Options
+ remote-port SSH port number on remote host (1-65535)
scp export
scp export
> url-block-page Use scp to export a comfort page to be presented when files are blocked due to a blocked URL
> url-coach-text Use scp to export text to be presented when files are blocked due to a blocked URL
> virus-block-page Use scp to export a comfort page to be presented when files are blocked due to a virus
> web-interface-certificate Use scp to export a web interface certificate
scp import
scp import
Uses SCP (secure copy) to download files to the device. Use this command to download a customizable
HTML replacement message (comfort page) in place of a malware infected file.
Syntax
scp import <option> from <source> {remote-port <port_number> | source-ip
<ip_address>}
{
anti-virus |
application-block-page |
captive-portal-text |
certificate |
configuration |
content |
device-state |
file-block-continue-page |
file-block-page |
global-protect-client |
global-protect-portal-custom-help-page profile <profile_name> |
global-protect-portal-custom-login-page profile <profile_name> |
global-protect-portal-custom-welcome-page profile <profile_name> |
high-availability-key |
keypair certificate-name <name> format {pem | pkcs12} passphrase <value> |
license |
logdb |
private-key certificate-name <name> format {pem | pkcs12} passphrase
<value> |
signed-url-database |
software |
ssl-cert-status-page |
ssl-optout-text |
ui-translation-mapping |
url-block-page |
url-coach-text |
url-database |
virus-block-page |
wf-content |
wildfire |
wildfire-api-keys |
wildfire-vm-image |
}
Options
+ remote-port SSH port number on remote host (1-65535)
+ source-ip Set source address to specified interface address (x.x.x.x or IPv6)
* from Source (username@host:path)
> anti-virus Use scp to import anti-virus content
> application-block-page Use scp to import application block comfort page
> captive-portal-text Use scp to import text to be used in a captive portal
scp import
Sample Output
The following command imports a license file from a file in user1s account on the machine with IP
address 10.0.3.4.
username@hostname> scp import certificate from [email protected]:/tmp/
certificatefile
set application
set application
Configures parameters for system behavior when applications are blocked.
Syntax
set application
{
cache {no | yes} |
dump |
{
off |
on
{
application <name> |
destination <ip_address> |
destination-port <port_number> |
destination-user <value> |
from <zone> |
limit <value> |
protocol <value> |
rule <name> |
source <ip_address> |
source-port <port_number> |
source-user <value> |
to <zone>
}
}
dump-unknown {no | yes} |
heuristics {no | yes} |
notify-user {no | yes} |
supernode {no | yes} |
traceroute
{
enable {no |yes} |
ttl-threshold <value>
}
Options
> cache Enables or disables the application cache
> dump Enables or disables the application packet capture. The following options determine the contents of the
dump:
+ application Specified application
+ destination Destination IP address of the session
+ destination-port Destination port
+ destination-user Destination user
+ from Specified zone
+ limit Maximum number of sessions to capture
+ protocol Specified protocol
+ rule Specified rule name
+ source Source IP address for the session
set application
Sample Output
The following command turns packet capture for unknown applications off.
username@hostname> set application dump-unknown off
username@hostname>
set cli
set cli
Configures scripting and pager options for the PAN-OS CLI. Options are included to display
configuration commands in default format, XML format, or as operational set commands.
Syntax
set cli
{
config-output-format {default | json | set | xml} |
confirmation-prompt {off | on} |
hide-ip |
hide-user |
pager {off | on} |
scripting-mode {off | on} |
terminal {height <value> | type <value> | width <value>} |
timeout idle {never | value>}
}
Options
> config-output-format Sets the output format for the configuration file to the default, JSON, XML format, or
set command format
> configuration-prompt Enables or disables presentation of a confirmation prompt for some configuration
commands
> hide-ip Hides the last octet of the IP address in logs
> hide-user Hides user names in logs
> scripting-mode Toggles scripting mode (scripting mode will modify the CLI output such that special
characters used for formatting are suppressed)
> pager Enables or disables pagers
> terminal Sets terminal parameters for CLI access
> height Sets terminal height (1-500)
> type Sets terminal type (press <tab> for list)
> width Sets terminal width (1-500)
> timeout Sets administrative session timeout values
+ idle Idle timeout (never or 0-1440 minutes; default = 60 minutes)
Sample Output
The following command sequence sets the configuration mode to use set command format for output
and then displays the output of the show system log-export-schedule command in Configuration
mode.
username@hostname> set cli config-output-format set
username@hostname> configure
Entering configuration mode
[edit]
username@hostname# edit deviceconfig
[edit deviceconfig]
username@hostname# show system log-export-schedule
set deviceconfig system log-export-schedule 10.16.0.97 description 10.16.0.97
set deviceconfig system log-export-schedule 10.16.0.97 enable yes
set cli
The following command sequence shows the same example after XML is specified as the command
output format.
username@hostname> set cli config-output-format xml
username@hostname> configure
Entering configuration mode
[edit]
username@hostname# edit deviceconfig
[edit deviceconfig]
username@hostname# show system log-export-schedule
<log-export-schedule>
<entry name="10.16.0.97">
<description>10.16.0.97</description>
<enable>yes</enable>
<log-type>threat</log-type>
<start-time>03:00</start-time>
<protocol>
<ftp>
<hostname>10.16.0.97</hostname>
<port>21</port>
<passive-mode>yes</passive-mode>
<username>admin</username>
<password>mZDB7rbW5y8=</password>
</ftp>
</protocol>
</entry>
</log-export-schedule>
[edit deviceconfig]
[edit deviceconfig]
username@hostname#
set clock
set clock
Configures the system date and time.
Syntax
set clock {date <value> | time <value>}
Options
+ date Specify the date in yyyy/mm/dd format
+ time Specify the time in hh:mm:ss format (hh: 0-23, mm: 0-59, ss: 0-59)
Sample Output
The following command sets the system date and time.
username@hostname> set clock date 2009/03/20 time 14:32:00
username@hostname>
set data-access-password
set data-access-password
Configures the access password for the data filtering logs. The data filtering log records information on
the security policies that help prevent sensitive information such as credit card or social security
numbers from leaving the area protected by the firewall.
Syntax
set data-access-password <pwd>
Options
<pwd> Specifies the password for accessing data filtering logs
Sample Output
The following command sets the password for data filtering logs.
username@hostname> set data-access password 12345678
username@hostname>
set management-server
set management-server
Configures parameters for the management server, which manages configuration, reports, and
authentication for the firewall.
Syntax
set management-server
{
logging {import-end | import-start | off | on} |
unlock admin <user_name>
}
Options
> logging Sets the following logging options:
import-end Exit import mode
import-start Enter import mode
off Disable logging
on Allow logging
> unlock Unlocks locked administrators (specify username of administrator to unlock)
Sample Output
The following command enables logging on the management server.
username@hostname> set management-server logging on
username@hostname>
set panorama
set panorama
Enables or disables the connection between the firewall and Panorama. For more information, refer to
the Panorama Administrators Guide.
Syntax
set panorama {off | on}
Options
on Enables the connection between the firewall and Panorama
off Disables the connection between the firewall and Panorama
Sample Output
The following command disables the connection between the firewall and Panorama.
username@hostname> set panorama off
username@hostname>
set password
set password
Configures the firewall password. When you issue this command, the system prompts you to enter the
old and new password and to confirm the new password.
Syntax
set password
Options
None
Sample Output
The following example shows how to reset the firewall password.
username@hostname>
Enter old password
Enter new password
Confirm password
set password
: (enter the old password)
: (enter the new password0
: (reenter the new password)
Password changed
username@hostname>
set serial-number
set serial-number
(Panorama only) Configures the serial number of the Panorama machine. The serial number must be set
for Panorama to connect to the update server.
Syntax
set serial-number <value>
Options
<value> Specifies the serial number or software license key
Sample Output
The following command sets the Panorama serial number to 123456.
username@hostname> set serial-number 123456
username@hostname>
set session
set session
Configures parameters for the networking session.
Syntax
set session
{
accelerated-aging-enable {no | yes} |
accelerated-aging-scaling-factor <value> |
accelerated-aging-threshold <value> |
default |
distribution-policy
{
fixed <value> |
hash {destination | source} |
ingress-slot |
random |
round-robin |
session-load
}
offload {no | yes} |
resource-limit-behavior {bypass | drop} |
scan-scaling-factor <value> |
scan-threshold <value> |
tcp-reject-non-syn {no | yes} |
timeout-captive-portal <value> |
timeout-default <value> |
timeout-discard-default <value> |
timeout-discard-tcp <value> |
timeout-discard-udp <value> |
timeout-icmp <value> |
timeout-scan <value> |
timeout-tcp <value> |
timeout-tcphandshake <value> |
timeout-tcpinit <value> |
timeout-tcpwait <value> |
timeout-udp <value>
}
Options
> accelerated-aging-enable Enables or disables accelerated session aging
> accelerated-aging-scaling-factor Sets the accelerated session aging scaling factor (power of 2, between 2-16)
> accelerated-aging-threshold Sets the accelerated aging threshold as a percentage of session utilization (50-99)
> default Restores all session settings to default values
> distribution-policy The PA-7050 platform logically partitions security processing and I/O and in most cases,
there is no set constraint that determines the slot or processor to which a given session is processed.
Administrators can use this CLI command to define how sessions are handled.
> fixed Select a fixed dataplane. This is mainly used for debugging purposes.
> hash Sessions are distributed based on a hash of the source address or destination address. This option is
recommended for environments that use large scale source NAT with Dynamic IP translation (DIP) and/or
set session
Dynamic IP and Port translation (DIPP). This is accomplished by improving the efficiency of NAT
resource management and by reducing the latency for NAT session setup due to potential IP/port conflicts.
When using DIP, it is recommended to set the source address option and for DIPP, use the destination
address option.
> ingress-slot This option is the default setting for session distribution. In this case, I/O and security
processing will be coupled on a per slot basis. Sessions will be distributed to the slot that contains the
ingress interface of the first packet and processor selection is based on a hash of the source address and
destination address. This option will attempt to reduce the number of times that a packet traverses the
switch fabric when the ingress and egress interfaces reside on the same slot, or in environments without an
asymmetric forwarding path. This option is recommended for latency-sensitive environments and because
I/O and firewalling are coupled, when a hot-swap of a card is needed in an HA configuration, session
migration may perform better.
> random The dataplane will be randomly selected from a pool of active dataplanes.
> round-robin This option will choose the dataplane based on round robin between active dataplanes;
meaning that I/O and security processing will be shared among all active dataplanes.
> session-load The dataplane is chosen based on the session count of each dataplane. The dataplane with
the lowest count is selected for security processing. This option is recommended for environments where
the I/O is distributed across multiple slots. For example, an inter-slot aggregate interface group or
environments with asymmetric forwarding.
> offload Enables or disables hardware session offload (Some firewall models have specialized hardware to
manage TCP, UDP, and ICMP sessions. This option enables or disables this capability. If it is disabled, the
sessions are managed by the firewall software.)
> resource-limit-behavior Behavior when resource limit is reached (bypass or drop)
> scan-scaling-factor Sets scan scaling factor (2-16)
> scan-threshold Resource utilization threshold to trigger session scan (50-99)
> tcp-reject-non-syn Rejects non-synchronized TCP packets for session setup (no or yes)
> timeout-captive-portal Sets captive portal session timeout value, in seconds (1-15999999)
> timeout-default Sets the session default timeout value, in seconds (1-604800)
> timeout-discard-default Sets timeout of non-TCP/UDP session in discard state (1-604800)
> timeout-discard-tcp Sets timeout of TCP session in discard state (1-604800)
> timeout-discard-udp Sets timeout of UDP session in discard state (1-604800)
> timeout-icmp Sets the session timeout value for ICMP commands (1-604800)
> timeout-scan Application trickling timeout value, in seconds (5-30)
> timeout-tcp Sets the session timeout value for TCP commands (1-5999999)
> timeout-tcphandshake Sets session tcp handshake timeout value, in seconds (1-60)
> timeout-tcpinit Sets the initial TCP timeout value, in seconds (1-60)
> timeout-tcpwait Sets the session TCP wait timeout value, in seconds (1-60)
> timeout-udp Sets the session timeout value for UDP commands (1-604800)
Sample Output
The following command sets the TCP timeout to 1 second.
username@hostname> set session timeout-tcpwait 1
username@hostname>
set ssh-authentication
set ssh-authentication
Configures a public key for Secure Shell (SSH) authentication.
Syntax
set ssh-authentication {public-key <value>}
Options
+ public-key Specifies the public key (RSA or DSA)
Sample Output
The following command configures the public key for SSH authentication.
username@hostname> set ssh-authentication public-key ssh-rsa AAAAB3N....
username@hostname>
set system
set system
Configures system operational parameters.
Syntax
set system
{
nfs dynamic-logging-partition threshold <value> |
setting
{
ctd |
{
regex-stats-on {no | yes} |
strip-x-fwd-for {no | yes} |
x-forwarded-for {no | yes}
}
fan-mode {auto | on} |
jumbo-frame {off | on} |
logging |
{
default |
default-policy-logging <value> |
log-suppression {no | yes} |
max-log-rate <value> |
max-packet-rate <value>
}
mp-memory-monitor enable {no | yes}|
packet-descriptor-monitor enable {no | yes}|
packet-path-test enable {no | yes}|
packet-path-test show |
multi-vsys {off | on}|
packet ip-frag-limit {no | yes} |
pow |
{
wqe-inuse-check {no | yes} |
wqe-swbuf-check {no | yes} |
wqe-swbuf-ref {no | yes} |
wqe-tag-check {no | yes}
}
shared-policy {disable | enable | import-and-disable} |
ssl-decrypt |
{
answer-timeout <value> |
notify-user {no | yes} |
skip-ssl {no | yes} |
skip-ssl-decrypt {no | yes}
}
target |
{
device-group <value> |
none |
set system
Options
>nfs
> setting Sets system settings
> ctd
> regex-stats-on Whether or not generate regular expression statistics
> strip-x-fwd-for Whether or not to strip x-forwarded-for from HTTP headers. When this option is
selected, the firewall zeroes out the header value before forwarding the request, and the forwarded
packets do not contain internal source IP information.
> x-forwarded-for Enables or disables parsing of the x-forwarded-for attribute
>fan-mode Sets fan to auto (fan turns on when needed) or on (always on); default = on
> jumbo-frame Sets jumbo frame mode
> logging Sets logging parameters
> default Restores logging parameters to the default settings
> default-policy-logging Sets the default log policy
> log-suppression Enables or disables log suppression (1-300)
> max-packet-rate value Sets the maximum packet rate for logging (0-50000)
> max-log-rate value Sets the maximum logging rate (0-2560)
> multi-vsys Enables or disables multiple virtual systems
> packet Enables or disables the IP fragmentation limit
> mp-memory-monitorSet monitoring of management memory
> packet-descriptor-monitorSet monitoring of packet descriptors
> packet-path-testEnable path test commands
> packet-path-test showShow which slots have path test enabled
> pow Enables or disables the Linux pow function Work Queue Entry (WQE) checks
> wqe-inuse-check Enable/disable WQE in-use check
> wqe-swbuf-check Enable/disable WQE software buffer trailer check
> wqe-swbuf-ref Enable/disable WQE software buffer ref in clone
> wqe-tag-check Enable/disable WQE session ID tag check
> shared-policy Enables, disables, or imports and disables shared policies
> ssl-decrypt Sets SSL decryption parameters
> answer-timeout Set ssl-decrypt answer timeout value (1-86400)
> notify-user Enable/disable notify user web page
> skip-ssl Enable/disable SSL decryption
> skip-ssl-decrypt Enable/disable ssl-decrypt
> target Target device group or template for operational commands
> device-group Target device group for operational commands
> none Unset target device group or template for operational commands
> template Target template for operational commands
set system
Sample Output
The following command enables logging suppression.
username@hostname> set system setting logging log-suppression yes
username@hostname>
show admins
show admins
Displays information about the active firewall administrators.
Syntax
show admins {all}
Options
+ all Lists the names of all administrators
Sample Output
The following command displays administrator information for the 10.0.0.132 firewall.
username@hostname> show admins | match 10.0.0
Admin
From
Type Session-start
Idle-for
-------------------------------------------------------------------------admin
10.0.0.132
Web 02/19 09:33:07
00:00:12s
username@hostname>
show arp
show arp
Displays current Address Resolution Protocol (ARP) entries.
Syntax
show arp <interface_name>
Options
<interface_name> Specifies the interface for which the ARP table is displayed
all Displays information for all ARP tables
ethernetn/m Displays information for the specified interface
loopback Displays loopback information
mgt Displays host ARP information
vlan Displays VLAN information
Sample Output
The following command displays ARP information for the ethernet1/1 interface on a PA-200 firewall
running PAN-OS 6.0.
username@hostname> show arp ethernet1/1
maximum of entries supported :
default timeout:
total ARP entries in table :
total ARP entries shown :
status: s - static, c - complete, i
500
1800 seconds
46
46
- incomplete
username@hostname>
show authentication
show authentication
Displays authentication information.
Syntax
show authentication {allowlist | groupdb | groupnames}
Options
> allowlist Displays the authentication allow list
> groupdb Lists the group authentication databases
> groupnames Lists the distinct group names
Sample Output
The following command shows the list of users that are allowed to access the firewall.
username@hostname> show authentication allowlist
vsysname
---------vsys1
vsys1
profilename
----------SSLVPN
wtam-SSLVPN
username
---------------------------paloaltonetwork\domain users
group1
username@hostname>
show chassis-ready
show chassis-ready
Shows whether the data plane has a running policy.
Syntax
show chassis-ready
Options
None
Sample Output
The following command shows that the data plane has a currently running policy.
username@hostname> show chassis-ready
yes
username@hostname>
show chassis
show chassis
Display chassis state and information.
Syntax
show chassis
{
inventory |
power |
status {slot <value>}
}
Options
> inventory Show chassis component information
> power Show chassis power usage information
> status Show chassis status information (can specify slot)
Sample Output
The following command shows chassis status.
username@hostname> show chassis status
Slot
Component
Card Status
1
PA-7000-20G-NPC
Up
2
PA-7000-20G-NPC
Up
3
empty
4
PA-7000-SMC
Up
5
PA-7000-20G-NPC
Up
6
empty
7
PA-7000-20G-NPC
Up
8
PA-7000-LPC
Up
Config Status
Success
Success
Disabled
Success
Success
Success
Success
username@hostname>
show cli
show cli
Displays information about the current CLI session.
Syntax
show cli {idle-timeout | info | permissions}
Options
> idle-timeout Displays timeout information for this administrative session
> info Displays various CLI information
> permissions Displays the information about the user role
Sample Output
The following command shows information about the current CLI session.
username@hostname> show
User
Process ID
Pager
Config Display Format
Vsys configuration mode
Vsys
cli info
: admin
: 19510
: enabled
: default
: enabled
: vsys1
username@hostname>
show clock
show clock
Shows the current time on the firewall.
Syntax
show clock {more}
Options
+ more Displays dataplane time
Sample Output
The following command shows the current time.
username@hostname> show clock
Mon Jun 20 21:03:54 PDT 2011
username@hostname>
show collector-messages
show collector-messages
(Panorama only) Displays log collector messages.
Syntax
show collector-messages collector <value> log-collector-group {default
collector | <value>}
Options
* collector Name of collector
* log-collector-group Name of log collector group
show commit-locks
show commit-locks
Displays the list of administrators who hold commit locks.
Syntax
show commit-locks
Options
None
show config
show config
Displays the active configuration.
Syntax
show config
{
audit |
{
base-version <value> |
base-version-no-deletes <value> |
info |
version <value>
}
candidate |
diff |
merged |
pushed-shared-policy {vsys <value>} |
pushed-template |
running {xpath <value>} |
saved <value> |
synced
}
Options
> audit Displays config audit information
> base-version Base version to show
> base-version-no-deletes Version with no deletes to show
> info Audit information to show
> version Audit version to show
> candidate Displays candidate configuration
> diff Displays the differences between the running and candidate configurations
> merged Displays pushed template and local config merge
> pushed-shared-policy Displays shared policy pushed to the device
+ vsys Virtual system to show
> pushed-template Displays template pushed to the device
> running Displays running configuration
+ xpath XPath of the node to retrieve
> saved Displays saved configuration
> synced Displays configuration last synchronized with HA peer
show config-locks
show config-locks
Displays the list of administrators who hold configuration locks.
Syntax
show config-locks
Options
None
show counter
show counter
Displays system counter information.
Syntax
show counter
{
global |
{
filter |
{
aspect <value> |
category <value> |
delta {no | yes} |
packet-filter {no | yes} |
severity {drop | error | info | warn} |
value {all | non-zero}
}
name
}
interface {all | management | <value>} |
management-server
}
Options
> global Displays global system counter information
> filter Apply counter filters
+ aspect Counter aspect
aa HA Active/Active mode
arp ARP processing
dos DoS protection
forward Packet forwarding
ipfrag IP fragment processing
mgmt Management-plane packet
mld MLD processing
nd ND processing
offload Hardware offload
parse Packet parsing
pktproc Packet processing
qos QoS enforcement
resource Resource management
session Session setup/teardown
system System function
tunnel Tunnel encryption/decryption
+ category Counter category
aho AHO match engine
appid Application-Identification
ctd Content-Identification
dfa DFA match engine
dlp DLP
show counter
Sample Output
The following command displays all configuration counter information grouped according to interface.
username@hostname> show counter interface
show counter
The following command displays all global counter information about the number of file forwards
found.
username@hostname> show counter global name ctd_file_forward
Name:
Value:
Severity:
Category:
Aspect:
Description:
ctd_file_forward
0
Informational
ctd
pktproc
The number of file forward found
username@hostname>
show deployment-update-status
show deployment-update-status
(Panorama only) Displays the deployment update schedule. For more information, refer to the
Panorama Administrators Guide.
Syntax
show deployment-update-schedule status name <value>
Options
> status Indicates that status will be shown
> name Name of the dynamic update schedule (specify value)
show device-messages
show device-messages
(Panorama only) Displays the policy messages for devices. For more information, refer to the
Panorama Administrators Guide.
Syntax
show device-messages device <value>
{
group <value> |
template <value>
}
Options
*device Name of device
> group Name of device group
> template Name of temple
Sample Output
The following command shows the device messages for the device pan-mgmt2 and the group dg1.
username@hostname> show device-messages device pan-mgmt2 group dg1
username@hostname>
show devicegroups
show devicegroups
(Panorama only) Displays information about device groups. For more information, refer to the
Panorama Administrators Guide.
Syntax
show devicegroups name <name>
Options
+ name Displays the information for the specified device group
Sample Output
The following command shows information for the device group dg1.
username@hostname> show devicegroups name dg1
==========================================================================
Group: dg3 Shared policy md5sum:dfc61be308c23e54e5cde039689e9d46
Serial
Hostname
IP
Connected
-------------------------------------------------------------------------PA04070001
pan-mgmt2
10.1.7.2
yes
last push state: push succeeded
vsys3 shared policy md5sum:dfc61be308c23e54e5cde039689e9d46(In Sync)
username@hostname>
show devices
show devices
(Panorama only) Shows the state of managed devices. For more information, refer to the Panorama
Administrators Guide.
Syntax
show device {all | connected}
Options
> all Displays information for all managed devices
> connected Displays information for all connected devices
Sample Output
The following command shows information for connected devices.
username@hostname> show devices connected
Serial
Hostname
IP
Connected
-------------------------------------------------------------------------PA04070001
pan-mgmt2
10.1.7.2
yes
last push state:
none
username@hostname>
show dhcp
show dhcp
Displays information about Dynamic Host Control Protocol (DHCP) leases.
Syntax
show dhcp
{
client state {all | <interface_name>} |
server
{
lease {all | <interface_name>} |
settings {all | <interface_name>}
}
}
Options
> client Shows DHCP client runtime information
all Displays the client state information for all interfaces
<interface_name> Specifies an interface (ethernetn/m)
> server Shows DHCP server runtime information
> lease Shows leases on one or all interfaces
> settings Shows settings on one or all interfaces
Sample Output
The following command shows the DHCP client state information for all interfaces.
username@hostname> show dhcp client state all
Interface
State
IP
Gateway
Leased-until
--------------------------------------------------------------------------ethernet1/3
Selecting
0.0.0.0
0.0.0.0
0
username@hostname>
The following command shows the DHCP server settings for all interfaces.
username@hostname> show dhcp server settings all
Interface
GW
DNS1
DNS2
DNS-Suffix
Inherit source
--------------------------------------------------------------------------ethernet1/11 10.100.1.1
0.0.0.0 0.0.0.0
ethernet1/3
username@hostname>
show dlc-query-state
show dlc-query-state
(Panorama only) Displays the DLC query job state.
Syntax
show dlc-query-state id <value>
Options
<value> Job ID value (1-4294967296)
show dlc-query-ui
show dlc-query-ui
(Panorama only) Displays DLC query jobs.
Syntax
show dlc-query-ui id <value> skip <value>
Options
* id Job ID (1-4294967296)
* skip Skip logs for paging (0-1000)
show dns-proxy
show dns-proxy
Displays information about the Domain Name Server (DNS) proxy.
Syntax
show dns-proxy
{
cache {all | name <value>} |
settings {all | name <value>} |
static-entries {all | name <value>} |
statistics {all | name <value>}
}
Options
> cache DNS proxy cache
> all Displays all DNS proxy cache information
> name Displays cache information for the specified DNS proxy object
> settings DNS proxy settings
> all Displays all DNS proxy settings
> name Displays settings for the specified DNS proxy object
> static-entries DNS proxy static entries
> all Displays all DNS proxy static entries
> name Displays static entries for the specified DNS proxy object
> statistics DNS proxy statistics
> all Displays all DNS proxy statistics
> name Displays statistics for the specified DNS proxy object
Sample Output
The following command displays all of the DNS proxy settings in the current session.
username@hostname> show dns-proxy settings all
Name: Nicks Proxy
Interfaces: ethernet1/10.1 ethernet1/10.2
Default name servers: 68.87.76.182 68.87.78.134
Status: Enabled
Match Rules:
backhaul to corporate dns:
engineering.paloaltonetworks.com *.paloaltonetworks.local *.local
10.0.0.2 10.0.0.3
My Company:
*.mycompany.*
11.11.11.253
-------------------------------------username@hostname>
show dos-protection
show dos-protection
Displays information about the Denial of Service (DoS) protection.
Syntax
show dos-protection
{
rule <name> |
{
settings |
statistics
}
zone <name> blocked source
}
Options
> rule Displays settings and statistics about the specified rule
> settings Show settings
> statistics Show statistics
> zone Displays information about the specified zone
show fips-mode
show fips-mode
Displays the status of the Federal Information Processing Standards (FIPS) 140-2 mode. For
information about enabling and disabling FIPS mode, refer to Chapter 6, Maintenance Mode.
Syntax
show fips-mode
Options
None
Sample Output
The following command shows that FIPS mode is off.
username@hostname> show fips-mode
off
username@hostname>
show global-protect
show global-protect
Show GlobalProtect agent software download redirect setting.
Syntax
show global-protect redirect
Options
None
show global-protect-gateway
show global-protect-gateway
Displays GlobalProtect gateway run-time objects.
Syntax
show global-protect-gateway
{
current-satellite {gateway <value> | satellite <value>} |
current-user |
{
domain <value> |
gateway <value> |
user <value>
}
flow {name <value> | tunnel-id <value>} |
flow-site-to-site {name <value> | tunnel-id <value>} |
gateway {name <value> | type {remote-user | satellite}} |
previous-satellite {gateway <value> | satellite <value>} |
previous-user
{
domain <value> |
gateway <value> |
user <value>
}
}
Options
> current-satellite Displays current GlobalProtect gateway satellites
+ gateway Displays the given GlobalProtect gateway
+ satellite Displays the satellites for which the satellite serial number starts with the string
> current-user Displays current GlobalProtect gateway users
+ domain Displays users for which the domain name starts with the string
+ gateway Displays the given GlobalProtect gateway
+ user Displays users for which the user name starts with the string
> flow Displays data plane GlobalProtect gateway tunnel information
> name Displays the given GlobalProtect gateway tunnel
> tunnel-id Displays specific tunnel information (1-65535)
> flow-site-to-site Displays dataplane GlobalProtect site-to-site gateway tunnel information
> name Displays the given GlobalProtect site-to-site gateway tunnel
> tunnel-id Displays specific tunnel information (1-65535)
> gateway Displays list of GlobalProtect gateway configurations
+ name Displays the given GlobalProtect gateway
+ type Displays remote user or satellite
- remote-user Show only remote user gateway configuration
- satellite Show only satellite gateway configuration
> previous-satellite Displays previous GlobalProtect gateway satellites
+ gateway Displays the given GlobalProtect gateway
+ satellite Displays the satellites for which the satellite serial number starts with the string
> previous-user Displays previous user session for GlobalProtect gateway users
+ domain Displays users which domain name start with the string
show global-protect-gateway
show global-protect-mdm
show global-protect-mdm
Displays options for GlobalProtect Mobile Security Manager.
Syntax
show global-protect-mdm
{
state {all | <value>} |
statistics
}
Options
> state Displays state of GlobalProtect servers
> statistics Displays GlobalProtect statistics
show global-protect-satellite
show global-protect-satellite
Displays GlobalProtect satellite run-time objects.
Syntax
show global-protect-satellite
{
current-gateway {gateway <value> | satellite <value>} |
satellite name <value>
}
Options
> current-gateway Displays current GlobalProtect gateway connection infos
+ gateway Displays gateway info for specified gateway (FQDN/IP address)
+ satellite Displays for given GlobalProtect satellite instance
> satellite Displays list of GlobalProtect satellite configuration
+ name Displays for given GlobalProtect satellite
show high-availability
show high-availability
Displays runtime information about the high availability subsystem.
Syntax
show high-availability
{
all |
control-link statistics |
dataplane-status |
flap_statistics |
ha2_keepalive |
interface <interface_name> |
link-monitoring |
path-monitoring |
slots |
state |
state-synchronization |
transitions |
virtual-address
}
Options
> all Displays high availability information
> control-link Displays control link statistic information
> dataplane-status Displays data plane runtime status
> flap-statistics Displays high availability preemptive/non-functional flap statistics
> ha2_keepalive Displays HA2 Keep-Alive statistics
> interface Displays high availability interface information
> link-monitoring Displays link monitoring state
> path-monitoring Displays path monitoring statistics
> slots Displays high availability slot information
> state Displays high availability state information
> state-synchronization Displays state synchronization statistics
> transitions Displays high availability transition statistic information
> virtual-address Displays the virtual addresses configured on the firewall in active-active high availability
mode, summarizing the virtual IPs and virtual MACs according to the interface on which they are configured
Sample Output
The following command shows information for the high availability subsystem.
username@hostname> show high-availability path-monitoring
---------------------------------------------------------------------------path monitoring:
disabled
total paths monitored:
0
---------------------------------------------------------------------------username@hostname>
show hsm
show hsm
Displays hardware security module (HSM) information.
Syntax
show hsm
{
client-address |
ha-status |
info |
is-priv-key-on-hsm certificate-name <value> |
nshield-connect-rfs |
servers |
slots |
state
}
Options
> client-address Show HSM client ip address
> ha-status Show HSM HA setting and members. Only valid for Luna SA
> info Show HSM info
> is-priv-key-on-hsm Query whether private key for a specified certificate is on HSM
> nshield-connect-rfs Show nshield-connect RFS info. Only valid for nShield Connect
> servers Show HSM registered servers
> slots Show HSM slots
> state Show HSM connection state
show interface
show interface
Displays information about system interfaces.
Syntax
show interface <interface_name>
Options
all Displays information for all ARP tables
ethernetn/m Displays information for the specified interface
hardware Displays all hardware interface information
logical Displays all logical interface information
loopback Displays loopback information
management Displays management interface information
tunnel Displays tunnel information
vlan Displays VLAN information
Sample Output
The following command displays information about an aggregate Ethernet interface named ae3.
username@hostname> show interface ae3
---------------------------------------------------------------------------Name: ae3, ID: 50
Link status:
Runtime link speed/duplex/state: unknown/unknown/down
Configured link speed/duplex/state: auto/auto/auto
MAC address:
Port MAC address 00:1b:17:0b:de:32
Aggregate group members: 2
ethernet1/5 ethernet1/6
Operation mode: layer3
Untagged sub-interface support: no
---------------------------------------------------------------------------Name: ae3, ID: 50
Operation mode: layer3
Virtual router default
Interface MTU 1500
Interface IP address: 23.23.23.31/24
Interface management profile: ping
ping: yes telnet: no ssh: no http: no https: no
snmp: no response-pages: no userid-service: no
Service configured: LACP
Zone: trust, virtual system: vsys1
Adjust TCP MSS: no
---------------------------------------------------------------------------Hardware interface counters read from CPU:
---------------------------------------------------------------------------bytes received
0
bytes transmitted
0
packets received
0
show interface
packets transmitted
0
receive errors
0
packets dropped
0
---------------------------------------------------------------------------Logical interface counters read from CPU:
---------------------------------------------------------------------------bytes received
0
bytes transmitted
0
packets received
0
packets transmitted
0
receive errors
0
packets dropped
0
packets dropped by flow state check
0
forwarding errors
0
no route
0
arp not found
0
neighbor not found
0
neighbor info pending
0
mac not found
0
packets routed to different zone
0
land attacks
0
ping-of-death attacks
0
teardrop attacks
0
ip spoof attacks
0
mac spoof attacks
0
ICMP fragment
0
layer2 encapsulated packets
0
layer2 decapsulated packets
0
----------------------------------------------------------------------------
show jobs
show jobs
Displays information about current system processes.
Syntax
show jobs {all | id <value> | pending | processed}
Options
> all Displays information for all jobs
> id number Identifies the process by number (1-4294967296)
> pending Displays recent jobs that are waiting to be executed
> processed Displays recent jobs that have been processed
Sample Output
The following command lists jobs that have been processed in the current session.
username@hostname> show jobs processed
Enqueued
ID
Type Status Result Completed
-------------------------------------------------------------------------2007/02/18 09:34:39
2 AutoCom
FIN
OK 2007/02/18 09:34:40
2007/02/18 09:33:00
1 AutoCom
FIN
FAIL 2007/02/18 09:33:54
username@hostname>
Syntax
show lacp aggregate-ethernet <ae-group-name>
Options
<ae-group-name> Specifies the name of the aggregate Ethernet group.
Sample Output
The following command shows information for an aggregate Ethernet group named ae1.
username@hostname> show
LACP:
AE Group: ae1
Members :
bndl
ethernet1/18 yes
ethernet1/19 yes
ethernet1/20 no
Status
Mode
Rate
Local
rx state
Current
Current
Defaulted
:
:
:
:
Enabled
Active
Fast
System Priority: 32768
System MAC
: AC-DE-48-03-67-80
Key
: 0001
Partner : System Priority: 00001
System MAC
: AC-DE-48-03-FF-FF
Key
: 0005
Port State
:
---------------------------------------------------------------------------Interface
Port
Number
Priority
Mode
Rate
Key
State
---------------------------------------------------------------------------ethernet1/18
Partner
33
12
127
200
Active
Passive
Fast
Slow
49
5
0x3D
0x3C
ethernet1/19
Partner
34
13
127
201
Active
Active
Fast
Fast
49
5
0x3D
0x3D
ethernet1/20
Partner
35
0
127
0
Active
Passive
Fast
Slow
50
0
0x45
0x00
---------------------------------------------------------------------------port Counters
---------------------------------------------------------------------------Interface
LACPDUs
Ethernet1/18
Ethernet1/19
Ethernet1/20
Sent
2082
31
22
Marker
Recv
2189
33
0
Sent
0
0
0
Marker response
Recv
0
3
0
Sent
0
3
0
Error
Recv
0
0
0
Unknown Illegal
0
0
0
0
15
2
show location
show location
Shows the geographic location of a firewall.
Syntax
show location ip <ip_address>
Options
<ip_address> Specifies the IP address of the firewall (x.x.x.x or IPv6)
Sample Output
The following command shows location information for the firewall 10.1.1.1.
username@hostname> show location ip 10.1.1.1
show location ip 201.52.0.0
201.52.0.0
Brazil
username@hostname>
show log
show log
Displays system logs.
Syntax
show log
{
alarm |
{
ack_admin equal <value> |
admin equal <value> |
csv-output equal {no | yes} |
direction equal {backward | forward} |
dport equal <port_number> |
dst equal <ip/netmask> |
end-time equal <value> |
opaque contains <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
rulegroup equal <value> |
sport equal <port_number> |
src equal <ip/netmask> |
start-time equal <value> |
time_acknowledged equal <value> |
vsys equal <value> |
}
appstat |
{
csv-output equal {no | yes} |
direction equal {backward | forward} |
end-time equal <value> |
name {equal | not-equal} <value> |
query equal <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
risk {equal | greater-than-or equal | less-than-or-equal | not-equal}
{1 | 2 | 3 | 4 | 5} |
start-time equal <value> |
type {equal | not-equal} <value>
}
config |
{
client {equal | not-equal} {cli | web} |
cmd {equal | not-equal} {add | clone | commit | create | delete | edit
| get | load-from-disk | move | rename | save-to-diak | set}|
csv-output equal {no | yes} |
direction equal {backward | forward} |
end-time equal <value> |
query equal <value> |
show log
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
result {equal | not-equal} {failed | succeeded | unauthorized} |
start-time equal <value>
}
dailythsum |
{
app {equal | not-equal} <value> |
csv-output equal {no | yes} |
direction equal {backward | forward} |
dst in <value> |
dstloc {equal | greater-than-or-equal | less-than-or-equal | not-equal}
<value> |
dstuser {equal | not-equal} <value> |
end-time equal <value> |
query equal <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
rule {equal | not-equal} <value> |
src in <value> |
srcloc {equal | greater-than-or-equal | less-than-or-equal | not-equal}
<value> |
srcuser {equal | not-equal} <value> |
start-time equal <value> |
subtype {equal | not-equal} <value> |
threatid {equal | greater-than-or-equal | less-than-or-equal | notequal} <value>
}
dailytrsum |
{
app {equal | not-equal} <value> |
csv-output equal {no | yes} |
direction equal {backward | forward} |
dst in <value> |
dstloc {equal | greater-than-or-equal | less-than-or-equal | not-equal}
<value> |
dstuser {equal | not-equal} <value> |
end-time equal <value> |
query equal <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
rule {equal | not-equal} <value> |
src in <value> |
srcloc {equal | greater-than-or-equal | less-than-or-equal | not-equal}
<value> |
srcuser {equal | not-equal} <value> |
start-time equal <value>
}
data |
{
action {equal | not-equal} {alert | allow | block-url | deny | drop |
show log
show log
<value> |
srcuser {equal | not-equal} <value> |
start-time equal <value> |
subtype {equal | not-equal} <value> |
threatid {equal | greater-than-or-equal | less-than-or-equal | notequal} <value>
}
hourlytrsum |
{
app {equal | not-equal} <value> |
csv-output equal {no | yes} |
direction equal {backward | forward} |
dst in <value> |
dstloc {equal | greater-than-or-equal | less-than-or-equal | not-equal}
<value> |
dstuser {equal | not-equal} <value> |
end-time equal <value> |
query equal <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
rule {equal | not-equal} <value> |
src in <value> |
srcloc {equal | greater-than-or-equal | less-than-or-equal | not-equal}
<value> |
srcuser {equal | not-equal} <value> |
start-time equal <value>
}
iptag |
{
datasource_subtype {equal | not-equal} <value> |
datasource_type {equal | not-equal} <value> |
datasourcename {equal | not-equal} <value> |
event_id {equal | not-equal} <value> |
ip {in | not-in} <ip/netmask> |
receive_time in <value> |
tag_name {equal | not-equal} <value> |
vsys equal <id> |
}
mdm receive_time in <value> ||
system |
{
csv-output equal {no | yes} |
direction equal {backward | forward} |
end-time equal <value> |
eventid {equal | not-equal} <value>
id {equal | not-equal} <value>
object {equal | not-equal} <value>
opaque contains <value> |
query equal <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
severity {equal | greater-than-or equal | less-than-or-equal | not-
show log
show log
{
action {equal | not-equal} {allow | deny | drop} |
app {equal | not-equal} <value> |
csv-output equal {no | yes} |
direction equal {backward | forward} |
dport {equal | not-equal} <port_number> |
dst {in | not-in} <ip/netmask> |
dstuser equal <user_name> |
end-reason equal {aged-out | decoder | tcp-fin | tcp-reuse | tcp-rstfrom-client | tcp-rst-from-server | policy-deny | threat |
resources-unavailable | unknown} |
end-time equal <value> |
from {equal | not-equal} <value>
query equal <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
rule {equal | not-equal} <value> |
sport {equal | not-equal} <port_number> |
src {in | not-in} <ip/netmask> |
srcuser equal <user_name> |
start-time equal <value> |
to {equal | not-equal} <value>
}
trsum |
{
app {equal | not-equal} <value> |
csv-output equal {no | yes} |
direction equal {backward | forward} |
dst in <value> |
dstloc {equal | greater-than-or-equal | less-than-or-equal | not-equal}
<value> |
dstuser {equal | not-equal} <value> |
end-time equal <value> |
query equal <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
rule {equal | not-equal} <value> |
src in <value> |
srcloc {equal | greater-than-or-equal | less-than-or-equal | not-equal}
<value> |
srcuser {equal | not-equal} <value> |
start-time equal <value>
}
url |
{
action {equal | not-equal} {alert | allow | block-url | deny | drop |
drop-all-packets | reset-both | reset-client | reset-server} |
app {equal | not-equal} <value> |
category {equal | not-equal} <value> |
csv-output equal {no | yes} |
direction equal {backward | forward} |
dport {equal | not-equal} <port_number> |
show log
show log
show log
Options
> alarm Displays alarm logs
+ ack_admin Acknowledging admin name (alphanumeric string)
+ admin Admin name (alphanumeric string)
+ csv-output Equals CSV output (no or yes)
+ direction Backward or forward direction
+ dport Destination port (0-65535)
+ dst Destination IP address (x.x.x.x/y or IPv6/netmask)
+ end-time Ending date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
+ opaque Opaque contains substring value
+ receive_time Receive time in the last specified time period (press <tab> for list)
+ rulegroup Rule group equals rule value
+ sport Source port (0-65535)
+ src Source IP address (x.x.x.x/y or IPv6/netmask)
+ start-time Starting date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
+ time_acknowledged Acknowledgement date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/
01@10:00:00)
+ vsys Virtual system name
> appstat Displays appstat logs
+ csv-output Equals CSV output (no or yes)
+ direction Backward or forward direction
+ end-time Ending date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
+ name Equal or not equal to name value
+ query Equal to query value
+ receive_time Receive time in the last specified time period (press <tab> for list)
+ risk Risk equal to, greater than or equal to, less than or equal to, or not equal to (1-5)
+ start-time Starting date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
+ type Type equal to or not equal to value
> config Displays config logs
+ client Client equals or does not equal CLI or Web
+ cmd Command equals or does not equal (press <tab> for list for commands)
+ csv-output Equals CSV output (no or yes)
+ direction Backward or forward direction
+ end-time Ending date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
+ query Equal to query value
+ receive_time Receive time in the last specified time period (press <tab> for list)
+ result Result equals or does not equal failed, succeeded, or unauthorized
+ start-time Starting date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
> dailythsum Displays daily thsum logs
+ app Equals or does not equal value
+ csv-output Equals CSV output (no or yes)
+ direction Backward or forward direction
+ dst Destination in value
+ dstloc Destination equal to, greater than or equal to, less than or equal to, or not equal to value
+ dstuser Equals or does not equal value
+ end-time Ending date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
+ query Equal to query value
+ receive_time Receive time in the last specified time period (press <tab> for list)
+ rule Equals or does not equal rule value
+ src Source in value
+ srcloc Source equal to, greater than or equal to, less than or equal to, or not equal to value
+ srcuser Equals or does not equal value
+ start-time Starting date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
show log
show log
show log
show log
show log
Sample Output
The following command shows the configuration log.
username@hostname> show log config
Time
Host
Command
Admin
Client Result
============================================================================
03/05 22:04:16 10.0.0.135
edit
admin
Web
Succeeded
03/05 22:03:22 10.0.0.135
edit
admin
Web
Succeeded
03/05 22:03:22 10.0.0.135
create
admin
Web
Succeeded
03/05 21:56:58 10.0.0.135
edit
admin
Web
Succeeded
...
show log
username@hostname>
show log-collector
show log-collector
Displays information about the device log collector.
Syntax
show log-collector
{
all |
connected |
detail |
hints |
serial-number <value> |
stats
{
runtime interval-type <value> ld <value> segment <value> {activesegments {no | yes}} |
storage ld <value> segment <value> {active-segments {no | yes}}
}
}
Options
> all All managed log collectors
> connected All connected log collectors
> detail Log collector details
> hints Show the hints stored on this Log collector
> serial-number Log collector serial number
> stats Log collector statistics
> runtime Show runtime statistics
+ active-segments Only display active segments
* interval-type Interval for the statistics, in minutes
* ld Logical disk number (1-4)
* segment Segment ID (all or 0-25)
> storage Show Storage statistics
+ active-segments Only display active segments
* ld Logical disk number (1-4)
* segment Segment ID (all or 0-25)
show log-collector-group
show log-collector-group
Displays information about log collector groups.
Syntax
show log-collector-group
{
all |
from ring-name {default | <name>} |
name {default | <name>}
}
Options
> all All managed log Collector Groups
> from ring-name Displays the following information about the Log Collectors in the named Collector Group:
serial number, IPv4 address, IPv6 address, disk size, number of segments, and identifiers for the RAID disk
pairs (Vld Id).
> name Log Collector Group name
Sample Output
The following command displays information about the default log collector group.
username@hostname> show log-collector-group name default
Group: default
Ring version 4 updated at 2012/04/25 18:07:12
Sent to log collectors at ?
Last pushed ring version 4
Min retention period 30
Total disk capacity 1863 GB
Last commit-all:
none updated at ?
Devices in the group:
Device 001606000100
Log collector pref list 003001000017
Device 001606000112
Log collector pref list 003001000014
Device 0008C100105
Log collector pref list 003001000014
Serial
Hostname
IP
Connected
sw version
show log-collector-group
---------------------------------------------------------------------------003001000017
M-100
12.3.456.70
yes
5.0
Last commit-all: commit succeeded, current ring version 4
md5sum 1262fa4e81e3ded4a1fe7ed4997c400a updated at ?
show logging-status
show logging-status
Displays information about log forwarding for each CMS.
Syntax
show logging-status
Options
None
Sample Output
The following command reports all available log forwarding statistics.
username@hostname> show logging-status
Type
CMS 0
config
system
threat
traffic
hipmatch
Not Available
Not Available
2011/06/20 18:03:44
2011/06/20 23:23:46
Not Available
0
0
1606507
6020338
0
CMS 1
Not Sending to CMS 1
username@hostname>
show mac
show mac
Displays MAC address information.
Syntax
show mac {all | <value>}
Options
all Displays all MAC information
<value> Displays specified VLAN MAC information (dot1q-vlan name)
Sample Output
The following command lists all currently MAC address information.
username@hostname> show mac all
maximum of entries supported :
8192
default timeout :
1800 seconds
total MAC entries in table :
4
total MAC entries shown :
4
status: s - static, c - complete, i - incomplete
vlan
hw address
interface
status
ttl
--------------------------------------------------------------------------Vlan56
0:0:1:0:0:3
ethernet1/5
c
1087
Vlan56
0:0:1:0:0:4
ethernet1/6
c
1087
Vlan11-12
0:0:1:0:0:9
ethernet1/12
c
487
Vlan11-12
0:0:1:0:0:10
ethernet1/11
c
487
username@hostname>
show management-clients
show management-clients
Shows information about internal management server clients.
Syntax
show management-clients
Options
None
Sample Output
The following command shows information about the internal management server clients.
username@hostname> show management-clients
Client PRI
State Progress
------------------------------------------------------------------------routed 30
P2-ok
100
device 20
P2-ok
100
ikemgr 10
P2-ok
100
keymgr 10
init
0
(op cmds only)
dhcpd 10
P2-ok
100
ha_agent 10
P2-ok
100
npagent 10
P2-ok
100
exampled 10
init
0
(op cmds only)
Overall status: P2-ok. Progress: 0
Warnings:
Errors:
show migration-log
show migration-log
Shows the migration log file.
Syntax
show migration-log
Options
None
Sample Output
The following command displays the migration log file.
username@hostname> show migration-log
[TBS]
show neighbor
show neighbor
Displays IPv6 neighbor information.
Syntax
show neighbor {all | mgt | <interface_name>}
Options
all Displays all IPv6 neighbor information
mgt Displays host IPv6 neighbor information
<interface_name> Displays IPv6 neighbor information for the specified interface
Sample Output
The following command displays all of the IPv6 neighbor information.
username@hostname> show neighbor all
maximum of entries supported :
default base reachable time:
total neighbor entries in table :
total neighbor entries shown :
1000
30 seconds
0
0
interface
ip address
hw address
status
---------------------------------------------------------------------------username@hostname>
show ntp
show ntp
Displays the Network Time Protocol (NTP) synchronization state.
Syntax
show ntp
Options
None
Sample Output
The following command displays the NTP synchronization state.
username@hostname> show ntp
NTP state:
NTP synched to LOCAL
username@hostname>
show object
show object
Shows the name of an address object with an IP address that exactly matches the address specified in
the filter.
Syntax
show object
{
dynamic-address-group {all | name <value>} |
registered-address {all option {count | file} | ip <ip/netmask> | tag
<value>} |
static ip <address> {vsys <name>}
}
Options
> dynamic-address-group Dynamic address object
> all Shows all dynamic address objects
> name Shows the dynamic address objects for the specified name
> registered-address Lists registered IP addresses
> all Shows all registered addresses
> ip Shows the registered address that matches the specific IP address
> tag Shows the register address that matches the specified tag
> static IP to object name
+ vsys Specifies the virtual system
* ip Specifies the IP address (x.x.x.x or IPv6)
Sample Output
The following command shows the name of an address object, one-more, with IP address 3.3.3.3 that
exists in virtual system vsys1.
username@hostname> show object static vsys vsys1 ip 3.3.3.3
one-more
username@hostname>
show operational-mode
show operational-mode
Displays the device operational mode.
Syntax
show operational-mode
Options
None
Sample Output
The following command shows the device operational mode.
username@hostname> show operational-mode
normal
username@hostname>
show panorama-certificates
show panorama-certificates
Lists certificate information for connection between the firewall and Panorama. Primarily used for
debugging purposes.
Syntax
show panorama-certificates
Options
None
Sample Output
The following command shows that the firewall has a Panorama certificate key file client.pem.
username@hostname> show panorama-certificates
-rw-r--r-- 1 root root 5.8K Oct 15 2010 client.pem
username@hostname>
show panorama-status
show panorama-status
Shows the Panorama connection status.
Syntax
show panorama-status
Options
None
Sample Output
The following command shows information about the Panorama connection.
username@hostname> show panorama-status
Panorama Server 1 : 10.1.7.90
State : Unknown
username@hostname>
show pbf
show pbf
Displays runtime statistics for policy-based forwarding (PBF).
Syntax
show pbf
{
return-mac {all | name <name>} |
rule {all | name <rule_name>}
}
Options
> return-mac PBF return MAC info
all Displays all current return MAC information
> name Displays the runtime statistics for a specified return MAC
> rule PBF rule status
> all Displays information about all current policy-based forwarding rules
> name Displays the runtime statistics for a specified policy-based forwarding rule
Sample Output
The following command shows the current PBF settings.
username@hostname> show pbf rule all
Rule
ID
State
R-Action Egress IF
NextHop
Interval
Threshold Status M-Action KA sent KA got Packets Matched
========== ===== ======== ======== ============ ================ ========
========= ====== ========= ======= ====== ===============
r1
4
Normal Discard
0.0.0.0
0
0
UP
Monitor 0
0
0
to-host
7
Normal Forward ethernet1/1 100.1.1.254
2
3
UP
Fail-Over 1270
1270 0
to-tunnel 8
Normal Forward ethernet1/3 201.1.1.254
2
3
DOWN Fail-Over 23
23
2
r5
9
Normal Forward ethernet1/9 0.0.0.0
2
3
UP
Fail-Over 0
0
3
username@hostname>
show pppoe
show pppoe
Displays statistics about the Point-to-Point Protocol over Ethernet (PPPoE) connections. The firewall
can be configured to be a PPPoE termination point to support connectivity in a Digital Subscriber Line
(DSL) environment where there is a DSL modem but no other PPPoE device to terminate the
connection.
Syntax
show pppoe interface {all | <interface_name>}
Options
all Displays PPPoE information for all interfaces
<interface_name> Displays PPPoE information for the specified firewall interface
Sample Output
The following command shows PPPoE information for the ethernet1/4 interface.
username@hostname> show pppoe interface ethernet1/4
Interface
PPPoE
PPP State
Username Access Concentrator MAC IP
ethernet1/4 Initiating Disconnected pa4020
Access Concentrator 00:11:22:33:44:55 10.0.2.2
username@hostname>
show qos
show qos
Shows Quality of Service (QoS) runtime information.
Syntax
show qos
{
interface <interface> |
counter |
match-rule |
throughput <value> |
tunnel-throughput <value>
}
Options
+ interface Specifies the QoS interface
> counter Displays software-based QoS counters
> match-rule Displays members of regular traffic configuration
> throughput Displays throughput (last 3 seconds) of all classes under the specified node-ID ((0-65535)
> tunnel-throughput Displays throughput (last 3 seconds) of all classes under the specified tunnel interface
Sample Output
The following command shows the QoS throughput for interface ethernet1/2, node default-group (ID
0):
username@hostname> show qos interface ethernet1/2 throughput 0
QoS throughput for interface ethernet1/2, node default-group (Qid 0):
class 4:
362 kbps
username@hostname>
show query
show query
Displays information about query jobs.
Syntax
show query {id <value> | jobs}
Options
> id Displays job information for the specified ID (1-4294967296)
> jobs Displays all job information
Sample Output
The following command shows information about all current query jobs.
username@hostname> show query jobs
Enqueued
ID Last Upd
-------------------------------------------------------------------------13:58:19
16 13:58:19
Type
ID Dequeued?
----------------------------------------------------username@hostname>
show report
show report
Displays information about process jobs.
Syntax
show report
{
custom |
{
aggregate-fields equal <value> |
database equal {appstat | threat | thsum | traffic | trsum} |
query equal <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
topn equal <value> |
value-fields equal <value>
}
directory-listing |
id <value> |
jobs |
predefined name equal {top-applications | top-attackers | top-attackersby-countries | top-attacks | top-connections | top-denied-applications
| top-denied-destinations | top-denied-sources | top-destinationcountries | top-destinations | top-egress-interfaces | top-egress-zones
| top-http-applications | top-ingress-interfaces | top-ingress-zones |
top-rules | top-source-countries | top-sources | top-spyware-threats |
top-url-categories | top-url-user-behavior | top-url-users | topvictims | top-victims-by-countries | top-viruses | top-vulnerabilities
| top-websites | unknown-tcp-connections | unknown-udp-connections}
{
end-time <value> |
start-time <value> |
}
}
Options
> custom Displays custom reports
+ aggregate-fields Report with comma-separated aggregate field names
+ database Data base report (appstat, threat, thsum, traffic, or trsum)
+ query Report formulated with the query string value
+ receive_time Report with the receive time in the specified time period (press <tab> for list)
+ topn Report of TopN return results
+ value-fields Report with comma-separated value field names
> directory-listing Displays report of directory listings
> id Displays reports by ID (1-4294967296)
> jobs Reports all jobs
> predefined Displays predefined reports
+ end-time End date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
+ start-time Start date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
show report
* name Predefined report of the specified name (press <tab> for list)
Sample Output
The following command shows the pre-defined report top-applications.
username@hostname> show report predefined name equal top-applications
<?xml version="1.0"?>
<report reportname="top-applications" logtype="appstat">
<result name="Top applications" logtype="appstat" start="2011/01/01 0
0:00:00" start-epoch="1293868800" end="2011/01/01 23:59:59" end-epoch="
1293955199" generated-at="2011/01/02 17:22:47" generated-at-epoch="1294
017767" range="Saturday, January 01, 2011">
<entry>
<name>icmp</name>
<nbytes>0</nbytes>
<nsess>480</nsess>
</entry>
<entry>
<name>ospf</name>
<nbytes>3920</nbytes>
<nsess>20</nsess>
</entry>
<entry>
<name>ping</name>
<nbytes>172</nbytes>
<nsess>2</nsess>
</entry>
</result>
</report>
username@hostname>
username@hostname>
show resource
show resource
Displays resource limits for policies, sessions, SSL VPN tunnels, and VPN tunnels.
Syntax
show resource limit {policies | session | ssl-vpn | vpn}
Options
> policies Displays the resource limit for policies
> session Displays the resource limit of the session
> ssl-vpn Displays the resource limit for SSL VPN tunnels
> vpn Displays the resource limit for site-to-site VPN tunnels
Sample Output
The following command shows the session resource limit.
username@hostname> show resource limit session
current session
max session
----------------- ----------------3044
262143
username@hostname>
show routing
show routing
Displays routing run-time objects.
Syntax
show routing
{
fib {virtual-router <name>} |
interface |
multicast |
{
fib |
{
group <ip/netmask> |
interface <value> |
source <ip/netmask> |
virtual-router <value>
}
group-permission |
{
interface <value> |
virtual-router <value>
}
igmp |
{
interface {virtual-router <value>} |
membership {interface <value> | virtual-router <value>} |
statistics {interface <value>}
}
pim |
{
elected-bsr |
group-mapping {group <ip/netmask> | virtual-router <value>} |
interface {virtual-router <value>} |
neighbor {virtual-router <value>} |
state |
{
group <ip/netmask> |
interface <value> |
rpt-only {no | yes} |
source {any | <ip/netmask>} |
virtual-router <value>
}
statistics {interface <value> | neighbor <ip/netmask>}
}
route
{
group <ip/netmask> |
interface <value> |
source <ip/netmask> |
virtual-router <value>
show routing
}
}
protocol |
{
bgp |
{
loc-rib {nexthop <ip/netmask> | peer <value> | prefix <ip/netmask> |
virtual-router <value>} |
loc-rib-detail {nexthop <ip/netmask> | peer <value> | prefix <ip/
netmask> | virtual-router <value>} |
peer {peer-name <value> | virtual-router <value>} |
peer-group {group-name <value> | virtual-router <value>} |
policy {aggregate | cond-adv | export | import} {virtual-router
<value>} |
rib-out {nexthop <ip/netmask> | peer <value> | prefix <ip/netmask> |
virtual-router <value>} |
rib-out-detail {nexthop <ip/netmask> | peer <value> | prefix <ip/
netmask> | virtual-router <value>} |
summary {virtual-router <value>}
}
ospf |
{
area {virtual-router <value>} |
dumplsdb {virtual-router <value>} |
graceful-restart {virtual-router <value>} |
interface {virtual-router <value>} |
lsdb {virtual-router <value>} |
neighbor {virtual-router <value>} |
summary {virtual-router <value>} |
virt-link {virtual-router <value>} |
virt-neighbor {virtual-router <value>}
}
ospfv3 |
{
area {virtual-router <value>} |
dumplsdb {virtual-router <value>} |
graceful-restart {virtual-router <value>} |
interface {virtual-router <value>} |
lsdb {virtual-router <value>} |
neighbor {virtual-router <value>} |
summary {virtual-router <value>} |
virt-link {virtual-router <value>} |
virt-neighbor {virtual-router <value>}
}
redist |
{
all {virtual-router <value>} |
bgp {virtual-router <value>} |
ospf {virtual-router <value>} |
rip {virtual-router <value>}
}
rip
{
database {virtual-router <value>} |
show routing
Options
> fib Displays Forwarding Information Base (FIB) entries (option to filter result by virtual router)
> interface Displays interface status
> multicast Displays multicast routing protocol information
> fib Displays multicast Forwarding Information Base (FIB) entries
+ group Filters result by multicast group address (IP address and network mask)
+ interface Filters result by incoming interface (interface name)
+ source Filters result by multicast source address (IP address and network mask)
+ virtual-router Filters result by virtual-router (router name)
> group-permission Displays multicast group permission
+ interface Filters result by incoming interface (interface name)
+ virtual-router Filters result by virtual-router (router name)
> igmp Displays Internet Group Management Protocol (IGMP) information
> interface Displays IGMP enabled interface status (option to filter result by virtual router)
> membership Displays IGMP membership information (options to filter result by interface or virtual
router)
> statistics Displays IGMP statistics (option to display statistics for specified IGMP interfaces)
> pim Displays Protocol Independent Multicast (PIM) information
> elected-bsr Displays address of elected bootstrap router (BSR)
> group-mapping Displays PIM group-rp mapping (options to filter result by group or virtual router)
> interface Displays PIM enabled interface status (option to filter result by virtual router)
> neighbor Displays PIM neighbor information (option to filter result by virtual router)
> state Displays current PIM multicast tree state
+ group Filters result by multicast group address
+ interface Displays interface specific states
+ rpt-only Displays only RPT states
+ source Displays (S, G) or (S, G, ...) states
+ virtual-router Filters result by virtual-router
> statistics Displays PIM statistics (options to filter result by interface or neighbor)
> route Displays multicast route entries
+ group Filters result by multicast group address (IP address and network mask)
+ interface Filters result by incoming interface (interface name)
+ source Filters result by multicast source address (IP address and network mask)
+ virtual-router Filters result by virtual-router (router name)
> protocol Displays dynamic routing protocol information
> bgp Displays Border Gateway Protocol (BGP) information
show routing
show routing
Sample Output
The following command shows summary routing information for the virtual router vrl.
username@hostname> show routing summary virtual-router vr1
VIRTUAL ROUTER: vr1 (id 1)
==========
OSPF
area id:
0.0.0.0
show routing
interface:
192.168.6.254
interface:
200.1.1.2
dynamic neighbors:
IP 200.1.1.1 ID 200.1.1.1
area id:
1.1.1.1
interface:
1.1.1.1
interface:
1.1.2.1
interface:
1.1.3.1
interface:
2.1.1.1
static neighbor:
IP 65.54.5.33 ID *down*
static neighbor:
IP 65.54.77.88 ID *down*
interface:
22.22.22.22
interface:
35.1.15.40
interface:
192.168.7.254
dynamic neighbors:
IP 35.1.15.1 ID 35.35.35.35
==========
RIP
interface:
2.1.1.1
interface:
22.22.22.22
interface:
35.1.15.40
interface:
192.168.6.254
interface:
200.1.1.2
==========
INTERFACE
==========
interface name:
ethernet1/1
interface index:
16
virtual router:
vr1
operation status:
up
IPv4 address:
22.22.22.22/24
IPv4 address:
35.1.15.40/24
==========
interface name:
ethernet1/3
interface index:
18
virtual router:
vr1
operation status:
up
IPv4 address:
200.1.1.2/24
==========
interface name:
ethernet1/7
interface index:
22
virtual router:
vr1
operation status:
up
IPv4 address:
1.1.1.1/24
IPv4 address:
1.1.2.1/24
IPv4 address:
1.1.3.1/24
==========
interface name:
ethernet1/15
interface index:
30
virtual router:
vr1
operation status:
up
IPv4 address:
192.168.6.254/24
==========
interface name:
ethernet1/16
interface index:
31
virtual router:
vr1
operation status:
up
IPv4 address:
192.168.7.254/24
==========
show routing
interface name:
interface index:
virtual router:
operation status:
IPv4 address:
ethernet1/18
33
vr1
down
2.1.1.1/24
username@hostname>
The following command shows dynamic routing protocol information for RIP.
username@hostname> show routing protocol rip summary
==========
virtual router:
reject default route:
interval seconds:
update intervals:
expire intervals:
delete intervals:
interface:
interface:
interface:
interface:
interface:
==========
virtual router:
reject default route:
interval seconds:
update intervals:
expire intervals:
delete intervals:
interface:
interface:
interface:
vr1
yes
1
30
180
120
2.1.1.1
22.22.22.22
35.1.15.40
192.168.6.254
200.1.1.2
newr
yes
1
30
180
120
0.0.0.0
30.30.30.31
151.152.153.154
show rule-use
show rule-use
Displays used and non-used policy rules.
Syntax
show rule-use
{
device-group <value> |
rule-base {app-override | cp | decryption | nat | pbf | qos | security} |
type used
}
Options
* device-group Displays information for the specified device group
* rule-base Rule base category
app-override Application override policy
cp Captive portal policy
decryption SSL decryption policy
nat Network Address Translation (NAT) policy
pbf Policy based forwarding (PBF) policy
qos Quality of service (QOS) policy
security Security policy
* type Rule use type (used)
show running
show running
Displays running operational parameters.
Syntax
show running
{
appinfo2ip |
application {cache | setting | statistics} |
application-override-policy |
application-signature statistics |
captive-portal-policy |
decryption-policy |
dos-policy |
global-ippool |
ippool |
ipv6 {address} |
logging |
nat-policy |
nat-rule-cache |
nat-rule-ippool rule <name> {show-cache {no | yes} | show-freelist {no |
yes}} |
pbf-policy |
qos-policy |
resource-monitor {day | hour | minute | second | week} {last <value>} |
rule-use rule-base {app-override | cp | decryption | dos | nat | pbf | qos
| security} type {unused | used} vsys <name> |
security-policy |
ssl-cert-cn |
tcp state |
top-urls {category <value> | top <value>} |
ts-agent-data {all | ip <ip/netmask> | source-user <value>} |
tunnel flow |
{
all |
{
filter state {active | inactive | init} |
filter type {ipsec | sslvpn}
}
context <value> |
info |
lookup |
name <tunnel_name> |
nexthop |
operation-stats |
tunnel-id <value>
}
url <value> |
url-cache {all | statistics} |
url-info <value> |
url-license
show running
Options
> appinfo2ip Displays application-specific IP mapping information
> application Displays application info (cache, setting, or statistics)
> application-override-policy Displays currently deployed application override policy
> application-signature Displays application signature statistics
> captive-portal-policy Displays currently deployed captive-portal policy
> decryption-policy Displays currently deployed decryption policy
> dos-policy Displays currently deployed DoS policy
> global-ippool Displays global IP pool status
> ippool Displays IP pool usage
> ipv6 Displays IPv6 information (option to show IPv6 addresses)
> logging Displays log and packet logging rate
> nat-policy Displays currently deployed Network Address Translation (NAT) policy
> nat-rule-cache Displays all NAT rules of all versions in cache
> nat-rule-ippool Displays specified NAT rule ippool usage
+ show-cache Displays reserve time cache
+ show-freelist Displays free list
* rule Specifies NAT rule name
> pbf-policy Displays currently deployed Policy-Based Forwarding policy
> qos-policy Displays currently deployed QoS policy
> resource-monitor Displays resource monitoring statistics
> day Per-day monitoring statistics (last 1-7 days)
> hour Per-hour monitoring statistics (last 1-24 hours)
> minute Per-minute monitoring statistics (last 1-60 minutes)
> second Per-second monitoring statistics (last 1-60 seconds)
> week Per-week monitoring statistics (last 1-13 weeks)
> rule-use Displays used/non-used policy rules
* rule-base Rule base name
app-override Application override policy
cp Captive portal policy
decryption SSL decryption policy
dos DoS protection policy
nat NAT policy
pbf Policy-based Forwarding policy
qos QoS policy
security Security policy
* type Rule use type (unused or used)
* vsys Virtual system name
> security-policy Displays currently deployed security policy
> ssl-cert-cn Displays SSL certificate common name cache
> tcp Displays TCP reassembly setup
> top-urls Displays top URLs statistics (for BrightCloud only)
+ category Specify the URL category
+ top First top elements (1-10000)
> ts-agent-data Displays terminal server agent data
> all Displays all terminal server agents data
> ip Displays terminal server agent data for IP address (x.x.x.x/y or IPv6/netmask)
> source-user Displays terminal server agent data for user
> tunnel Displays runtime tunnel states
> all Displays all tunnels
+ filter Specifies filters
+ state Tunnel state (active, inactive, initial state)
+ type Tunnel type (IPSec or SSL-VPN tunnel)
show running
Sample Output
The following command shows statistics for running applications.
username@hostname> show running application statistics
Time: Wed Feb 17 15:16:30 2010
Vsys: 1
Number of apps: 31
App (report-as) sessions
packets
--------------- ---------- ---------15
495
188516
16
11
1803
32
464
467
36
518
16395
37
2
2574
42
1888
4101
44
1
1
48
29
686
50
2
7
79
2
185
86
9
115
109
1604
75513
147
155
374
193
0
3
225
12
272
280
77
217
318
48
85
452
2
139
453
1
9
491
21
1293
518
128
98192
658
6
70
674
53
1487
735
8
8446
796
1
16
852
1
117
872
49
2852
900
24
2206
980
32
573
1019
412
2679
1024
913
6971
bytes
-----------99646149
1319859
51055
1921997
273600
454433
422
225194
2741
97363
25843
55339483
33660
1018
71706
44906
30161
109886
1914
812870
96499118
18944
1122891
8385474
4215
87965
2296433
1179538
233308
200506
549052
app changed
----------0
0
0
0
0
0
1
0
0
2
8
0
0
1
12
0
0
2
1
21
128
6
53
8
1
1
49
24
32
0
0
threats
------0
0
3
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
show running
show session
show session
Displays session information.
Syntax
show session
{
all |
{
filter
{
application <name> |
count {no | yes} |
destination <ip_address> |
destination-port <port_number> |
destination-user {known-user | unknown | <value>} |
egress-interface <value> |
from <zone> |
hw-interface <value> |
ingress-interface <value> |
min-kb <value> |
nat {both | destination | none | source} |
nat-rule <rule_name> |
pbf-rule <rule_name> |
protocol <value> |
qos-class <value> |
qos-node-id <value> |
qos-rule <rule_name> |
rematch security-policy |
rule <rule_name> |
source <ip_address> |
source-port <port_number> |
source-user {known-user | unknown | <value>} |
ssl-decrypt {no | yes} |
start-at <value> |
state {active | closed | closing | discard | initial | opening} |
to <zone> |
type {flow | predict} |
vsys-name <name>
}
start-at <value>
}
id <number> |
info |
meter
rematch
}
Options
> all Displays active sessions
show session
Sample Output
The following command displays session statistics.
username@hostname> show session info
------------------------------------------------------------------------------number of sessions supported:
524287
number of active sessions:
498520
number of active TCP sessions:
0
number of active UDP sessions:
498518
number of active ICMP sessions:
0
number of active BCAST sessions:
0
number of active MCAST sessions:
0
number of predict sessions:
0
show session
371731
c2s flow:
source:
dst:
sport:
proto:
state:
ipver:
src-user:
dst-user:
PBF rule:
qos node:
ez fid:
s2c flow:
source:
dst:
sport:
proto:
state:
ipver:
src-user:
dst-user:
ez fid:
start time
timeout
172.16.40.20[L3Intranet]
84.72.62.7
49230
dport:
31162
17
dir:
c2s
ACTIVE
type:
FLOW
4
qa2003domain-b\kwisdom
unknown
rule4(2)
ethernet1/14, qos member N/A Qid 0
0x0d208003(13, 0, 0, 3)
84.72.62.7[L3Extranet]
172.16.40.20
31162
dport:
49230
17
dir:
s2c
ACTIVE
type:
FLOW
4
unknown
qa2003domain-b\kwisdom
0x0ca0703f(12, 2, 3, 63)
: Fri Jan 15 15:55:56 2010
: 1200 sec
show session
time to live
:
total byte count
:
layer7 packet count
:
vsys
:
application
:
rule
:
session to be logged at
session in session ager
session sync'ed from HA
layer7 processing
URL filtering enabled
URL category
ingress interface
egress interface
session QoS rule
1076 sec
145
0
vsys1
bittorrent
rule23
end
:
:
peer
:
:
:
:
:
:
:
yes
yes
yes
completed
yes
any
ethernet1/13
ethernet1/14
default (class 4)
show sslmgr-store
show sslmgr-store
Displays the store for the Secure Socket Layer (SSL) manager that validates certificates for the
Certificate Revocation List (CRL) and the Online Certificate Status Protocol (OCSP). Each trusted
certificate authority (CA) maintains CRLs to determine if an SSL certificate is valid (not revoked) for
SSL decryption. The OCSP can also be used to dynamically check the revocation status of a certificate.
Syntax
show sslmgr-store
{
certificate-info |
{
issuer <value> |
portal {db-serialno <value> | name <value> | serialno <value>}
}
config-ca-certificate |
{
publickey-hash <value> |
subjectname-hash <value>
}
config-certificate-info |
{
db-serialno <value> |
issuer-subjectname-hash <value>
}
satellite-info |
{
portal
{
name <value> |
serialno <value> |
state {assigned | unassigned}
}
serialno-certificate-info {db-serialno <value>}
}
Options
> certificate-info Displays list of certificate status
> issuer Show all certificate status information signed by issuing entity
> portal GlobalProtect portal
+ db-serialno Certificate serial number
+ name shows certificate status for given GlobalProtect portal
+ serialno GlobalProtect satellite serial number
> config-ca-certificate Displays list of config CA certificate
+ publickey-hash Certificate public key hash (sha1)
+ subjectname-hash Certificate subject name hash (sha1)
> config-certificate-info Displays list of config certificate status
+ db-serialno Certificate serial number
+ issuer-subjectname-hash Issuer subject name hash (sha1)
> satellite-info Displays list of registered satellites
show sslmgr-store
show statistics
show statistics
Displays firewall statistics.
Syntax
show statistics
Options
None
Sample Output
The following command displays firewall statistics.
username@hostname> show statistics
TASK
PID N_PACKETS CONTINUE
ERROR
DROP
BYPASS TERMINATE
0
0
0
0
0
0
0
0
1
806
6180587
6179536
39
0
0
1012
2
807
39312
37511
0
0
0
1801
3
808 176054840 173273080
2289
2777524
0
1947
4
809 112733251 111536151
1744
1194906
0
450
5
810 66052142 65225559
1271
825010
0
302
6
811 49682445 49028991
909
652227
0
318
7
812 43618777 43030638
712
587129
0
298
8
813 41255949 40706957
708
548031
0
253
9
814 42570163 42010404
714
558773
0
272
10
815
7332493
7332494
0
0
0
0
task 1(pid:
806) flow_mgmt
task 2(pid:
807) flow_ctrl flow_host
task 3(pid:
808) flow_lookup flow_fastpath flow_slowpath flow_forwarding
flow_np
task 4(pid:
809) flow_lookup flow_fastpath flow_slowpath flow_forwarding
flow_np
task 5(pid:
810) flow_lookup flow_fastpath flow_slowpath flow_forwarding
flow_np
task 6(pid:
811) flow_lookup flow_fastpath flow_slowpath flow_forwarding
flow_np
task 7(pid:
812) flow_lookup flow_fastpath flow_slowpath flow_forwarding
flow_np
task 8(pid:
813) flow_lookup flow_fastpath flow_slowpath flow_forwarding
flow_np
task 9(pid:
814) flow_lookup flow_fastpath flow_slowpath flow_forwarding
flow_np
task 10(pid:
815) appid_result
show system
show system
Displays system-related information.
Syntax
show system
{
disk-space |
environmentals {fans | fan-tray | power | power-supply | slot <value> |
thermal} |
files |
info |
logdb-quota |
masterkey-properties |
packet-path-test status {slot <value>} |
raid detail |
resources {follow} |
services |
setting |
{
ctd |
{
state |
threat {application <value> | id <value> | profile <value>} |
url-block-cache
}
jumbo-frame |
logging |
multi-vsys |
packet |
pow |
shared-policy |
ssl-decrypt {certificate | certificate-cache | exclude-cache | memory
{detail} | notify-cache | setting} |
target-vsys |
template |
url-cache {all | statistics} |
url-database |
url-filtering-feature |
util |
zip
}
software status {slot <value>}|
state {browser | filter | filter-pretty} |
statistics {application vsys <name> | session}
}
Options
> disk-space Reports file system disk space usage
> environmentals Displays system environment state (fan-tray, fans, power, power-supply, slot, thermal)
show system
Sample Output
The following command displays system information.
username@hostname> show system info
hostname: thunder
ip-address: 10.1.7.1
netmask: 255.255.0.0
default-gateway: 10.1.0.1
ipv6-address:
ipv6-default-gateway:
show system
mac-address: 00:13:72:3c:c9:e3
time: Tue Feb
9 10:02:57 2010
The following command shows an example with the default threat action.
username@hostname> show system setting ctd threat 100000 application 109
profile 1
Profile 1 appid 109 , action 0
action 0 means default action.
username@hostname>
The following command displays log database quotas and disk usage.
username@hostname> show system logdb-quota
Quotas:
traffic: 32.00%, 14.650 GB
threat: 16.00%, 7.325 GB
system: 4.00%, 1.831 GB
config: 4.00%, 1.831 GB
alarm: 3.00%, 1.373 GB
trsum: 12.00%, 5.494 GB
hourlytrsum: 2.00%, 0.916 GB
dailytrsum: 2.00%, 0.916 GB
weeklytrsum: 2.00%, 0.916 GB
thsum: 4.00%, 1.831 GB
hourlythsum: 2.00%, 0.916 GB
dailythsum: 2.00%, 0.916 GB
weeklythsum: 2.00%, 0.916 GB
appstat: 12.00%, 5.494 GB
application-pcaps: 1.00%, 0.458 GB
threat-pcaps: 1.00%, 0.458 GB
debug-filter-pcaps: 1.00%, 0.458 GB
dlp-logs: 1.00%, 0.458 GB
Disk usage:
traffic: Logs: 12G, Index: 2.9G
threat: Logs: 21M, Index: 560K
system: Logs: 90M, Index: 11M
config: Logs: 112K, Index: 512K
alarm: Logs: 8.0K, Index: 8.0K
trsum: Logs: 379M, Index: 57M
hourlytrsum: Logs: 379M, Index: 57M
show system
The following command displays the times of the last generated thsum and trsum logs.
username@hostname> show system log-summary status
hourlytrsum: last generated 2011/01/23 12:00:10
dailytrsum: last generated 2011/01/23 00:00:20
weeklytrsum: last generated 2011/01/23 00:00:30
hourlythsum: last generated 2011/01/23 12:00:12
dailythsum: last generated 2011/01/23 00:00:23
weeklythsum: last generated 2011/01/23 00:00:35
show templates
show templates
(Panorama only) Displays defined templates.
Syntax
show templates name <value>
Options
name Specifies the template name
Sample Output
The following command shows template configurations.
username@hostname> show template name name
[TBS]
username@hostname>
show threat
show threat
Displays threat ID descriptions.
Syntax
show threat id <value>
Options
<value> Specifies the threat ID (1-4294967296)
Sample Output
The following command shows threat ID descriptions for ID 11172.
username@hostname> show threat id 11172
This signature detects the runtime behavior of the spyware MiniBug. MiniBug,
also known as Weatherbug, installs other spyware, such as WeatherBug, and
My Web Search Bar. It is also adware program that displays advertisements
in its application window.
medium
http://www.spywareguide.com/product_show.php?id=2178
http://www.spyany.com/program/article_spw_rm_Minibug.htm
username@hostname>
show url-cloud
show url-cloud
Displays the URL cloud status.
Syntax
show url-cloud status
Options
None
Sample Output
The following command displays the status for the URL cloud.
username@hostname> show url-cloud status
PAN-DB URL Filtering
License :
Current cloud server :
Cloud connection :
URL database version URL database version 23 11:2
0:22 )
URL database status :
URL protocol version URL protocol version Protocol compatibility
device :
cloud :
device :
cloud :
status :
valid
s0200.urlcloud.paloaltonetworks.com
connected
2012.03.22.182
2012.03.22.182 ( last update time 2012/03/
good
pan/0.0.2
pan/0.0.2
compatible
username@hostname>
show user
show user
Displays user identification information. You can show information for a specified IP address, user, or
all.
Syntax
show user
group |
{
list |
+ xmlapi
| {except <value>| match <value>}
name <value>}
}
group-mapping |
{
naming-context server {<ip/netmask> | <host_name>} |
{
is-active-directory {no | yes} |
proxy-agent {<ip/netmask> | <host_name>} |
proxy-agent-port <value> |
server-port <value> |
use-ssl {no | yes}
}
state {all | <value>} |
statistics
}
group-mapping-service |
{
query {all | local | remote} |
status
}
group-selection server {<ip/netmask> | <host_name>} |
{
base <value> |
bind-dn <value> |
bind-password <value> |
container-object <value> |
filter <value> |
force {no | yes} |
group-object <value> |
name-attribute <value> |
proxy-agent {<ip/netmask> | <host_name>} |
proxy-agent-port <value> |
search-scope {one | subtree} |
server-port <value> |
use-ssl {no | yes}
}
ip-port-user-mapping {all | ip <ip/netmask> | source-user <value>} |
ip-user-mapping |
show user
{
option {count | detail} |
type { AD | CP | EDIR | GP | NTLM | SSL/VPN | UIA | UNKNOWN | XMLAPI} |
all |
ip <ip/netmask>
}
ip-user-mapping-mp |
{
no-group-only {no | yes} |
option {count | detail} |
type { AD | CP | EDIR | GP | NTLM | SSL/VPN | UIA | UNKNOWN | XMLAPI} |
all |
ip <ip/netmask>
}
local-user-db |
{
disabled {no |yes} |
username <name> |
vsys <name>
}
server monitor |
{
auto-discover {domain | except <value>| match <value>} |
state {all | <name>}|
statistics | {except | match}
}
ts-agent statistics |
{
state {all | <value>} |
statistics
}
user-IDs {match-user <value>} |
user-id-agent |
{
config name <value> |
state {all | <name>} |
statistics
}
user-id-service
{
client {all | <ip/port>} |
status
}
xml-api multiusersystem
}
Options
> group Displays user groups data
> list Lists all groups
+xml_api Lists groups from XML API
> name Displays group's members
> group-mapping Displays group mapping states
> naming-context Displays naming context for directory server
show user
show user
Sample Output
The following command displays user ID information for a specified user (in this case, the root user).
username@hostname> show user-IDs match-user paloaltonetwork\root
User Name
Vsys
Groups
-----------------------------------------------------------------paloaltonetwork\root
vsys1
paloaltonetwork\domain users
paloaltonetwork\users
username@hostname>
show virtual-wire
show virtual-wire
Displays information about virtual wire interfaces.
Syntax
show virtual-wire {all | default-vwire | <value>}
Options
all Displays all virtual wire information
default-vwire Displays information about the default virtual wire
<value> Specifies a virtual wire interface
Sample Output
The following command displays information for the default virtual wire interface.
username@hostname> show virtual-wire default-vwire
name
interface1
interface2
-----------------------------------------------------------------------------default-vwire
ethernet1/1
ethernet1/2
username@hostname>
show vlan
show vlan
Displays VLAN information.
Syntax
show vlan {all | <value>}
Options
all Shows information for all VLANs
<value> Specifies a VLAN name
Sample Output
The following command displays information for all VLANs.
username@hostname> show vlan all
total vlan shown :
name
interface
virtual interface
layer3 forwarding
---------------------------------------------------------------------------TheTenOne
ethernet1/1.1001 vlan.1001
enabled
ethernet1/10.1001
ethernet1/2.1001
ethernet1/5.1001
ethernet1/6.1001
ethernet1/7.1001
ethernet1/8.1001
ethernet1/9.1001
ethernet1/4.1001
ae1
ethernet1/13.1001
TheTenTwo
ethernet1/1.1002 vlan.1002
enabled
ethernet1/2.1002
ethernet1/5.1002
ethernet1/6.1002
ethernet1/7.1002
ethernet1/8.1002
ethernet1/9.1002
ethernet1/10.1002
ethernet1/14
ethernet1/13.1002
username@hostname>
show vm-monitor
show vm-monitor
Displays VM monitoring information.
Syntax
show vm-monitor{ source [state (all | <name>) | statistics ]
| ref-id <value> | source-name <value> | summary ] }
| vms [ summary
Options
<value> Specifies a value for the specified parameter
show vpn
show vpn
Displays Virtual Private Network (VPN) information.
Syntax
show vpn
{
flow {name <name> | tunnel-id <value>} |
gateway {name <name>} |
ike-sa {gateway <value>} |
ipsec-sa {tunnel <value>} |
tunnel {name <name>}
}
Options
> flow Displays information about the IPSec VPN tunnel on the data plane
> name Specifies VPN tunnel name
> tunnel-id Specifies VPN tunnel ID (1-65535)
> gateway Displays Internet Key Exchange (IKE) gateway configuration
+ name Specifies IKE gateway
> ike-sa Displays information about the active IKE Security Association (SA)
+ gateway Specifies IKE gateway
> ipsec-sa Displays information about IPsec SA tunnels
+ tunnel Specifies VPN tunnel
> tunnel Displays auto-key IPSec tunnel configuration
+ name Specifies VPN tunnel
Sample Output
The following command shows VPN information for the auto key IPsec tunnel k1.
username@hostname> show vpn tunnel name k1
TnID Name(Gateway)
Local Proxy IP
Ptl:Port Remote Proxy
IP
Ptl:Port Proposals
---- ---------------------------------- ---------------------- --------2 t-5(ike5)
0.0.0.0/0
0:0
0.0.0.0/0
0:0
ESP tunl [DH2][AES128,3DES][SHA1] 3600-sec
3 t-6(ike6)
0.0.0.0/0
0:0
0.0.0.0/0
0:0
ESP tunl [DH2][AES128,3DES][SHA1] 3600-sec
6 myBlue72Tunnel(to_100)
0.0.0.0/0
0:0
0.0.0.0/0
0:0
ESP tunl [DH2][AES128,3DES][SHA1] 3600-sec
Show IPSec tunnel config: Total 3 tunnels found.
username@hostname>
show vpn
The following command shows VPN information for the IKE gateway g2.
username@hostname> show vpn tunnel name g2
GwID Name
Peer Address/ID
Local Address/ID
---- --------------------------------3 falcon-kestrel
35.1.15.1
35.1.15.40
[PSK][DH2][AES128,3DES][SHA1] 28800-sec
Protocol
Proposals
---------------Auto(main)
show wildfire
show wildfire
Displays Wildfire disk usage, statistics, and status.
Syntax
show wildfire
{last-device-registration all |
{latest {analysis | samples | sessions | uploads}
{days <value> | filter column <name> value <value>} | limit <value> |
sort-by <value> | sort-direction {asc | desc}} |
sample-status sha256 equal <value> |
cloud-info
disk-usage
statistics {days <value>} |
status
vm-images
Options
> last-device-registration Show list of latest registration activities
> latest Show latest 30 activities (analysis, samples, sessions, upload)
+ days Set number of days to look back, default is 1
+ filter Filter output based on column and value
+ limit Set number of rows to display, default is 30
+ sort-by Set field to sort on
+ sort-direction Set sort direction (ascending [asc] or descending [desc])
> sample-status Show wildfire sample status
> cloud-info Show cloud information
> disk-usage Show disk usage information
> statistics Show basic wildfire statistics
> status Show status
> vm-images Show VM images
Sample Output
The following command displays Wildfire status
username@hostname> show wildfire status
Connection info:
Wildfire cloud:
Status:
Auto-Submit:
Selected VM:
VM internet connection:
VM network using Tor:
Best server:
Device registered:
Service route IP address:
Signature verification:
Server selection:
Through a proxy:
dev4.wildfire.paloaltonetworks.com
Idle
enabled
vm-2
enabled
disabled
dev4.wildfire.paloaltonetworks.com
yes
10.5.164.238
enable
enable
no
show wildfire
username@hostname>
The following command displays Wildfire statistics for the past 12 days.
username@hostname> show wildfire statistics days 12
Last one hour statistics
Total sessions submitted
Samples submitted
analyzed
pending
malicious
benign
error
uploaded
:
:
:
:
:
:
:
:
:
0
0
0
0
0
0
0
0
:
:
:
:
:
:
:
:
:
37
7
7
0
1
6
0
1
username@hostname>
show wildfire
default cloud
no
10.16.3.223
enable
no
Forwarding info:
file size limit (MB):
file idle time out (minute):
total file forwarded:
forwarding rate (per minute):
concurrent files:
5
3
0
0
0
username@hostname>
show zone-protection
show zone-protection
Displays the running configuration status and run time statistics for zone protection elements.
Syntax
show zone-protection {zone <zone_name>}
Options
<zone_name> Specifies the name of a zone
Sample Output
The following command shows statistics for the trust zone.
username@hostname> show zone-protection zone trust
--------------------------------------------------------------------------Zone trust, vsys vsys1, profile custom-zone-protection
---------------------------------------------------------------------------tcp-syn
enabled: no
---------------------------------------------------------------------------udp
RED enabled: no
---------------------------------------------------------------------------icmp
RED enabled: no
---------------------------------------------------------------------------other-ip
RED enabled: no
---------------------------------------------------------------------------packet filter:
discard-ip-spoof:
enabled: no
discard-ip-frag:
enabled: no
discard-icmp-ping-zero-id:
enabled: no
discard-icmp-frag:
enabled: no
discard-icmp-large-packet:
enabled: no
reply-icmp-timeexceeded:
enabled: no
username@hostname>
ssh
ssh
Opens a secure shell (SSH) connection to another host.
Syntax
ssh host <value>
{
inet {no | yes} |
port <port_number> |
source <ip_address> |
v1 {no | yes} |
v2 {no | yes}
}
Options
+ inet Force to IPv4 destination
+ port Port to connect to on the remote host (1-65535; default = 22))
+ source Source address for SSH session
+ v1 Force SSH to try protocol version 1 only (default = version 2)
+ v2 Force SSH to try protocol version 2 only
* host Host name or IP address of remote host
Sample Output
The following command opens an SSH connection to host 10.0.0.250 using SSH version 2.
username@hostname> ssh v2 [email protected]
[email protected]'s password:
#
tail
tail
Prints the last 10 lines of a debug file.
Note: The dp-log option will not be available on devices that do not have a dataplane, such as the PA200.
Syntax
tail
{
follow {no | yes} |
lines <value> |
agent-log <value> |
dp-log <file> |
mp-log <file> |
webserver-log <file>
}
Options
+ follow Outputs appended data as the file grows
+ lines Outputs the last N lines, instead of the last 10 (1-65535)
> agent-log Agent log file to display (press <tab> for a list of numbers)
> dp-log Data plane log file to display (press <tab> for list of files)
> mp-log Management plane log file to display (press <tab> for list of files)
> webserver-log Web server log file to display (press <tab> for list of files)
Sample Output
The following command displays the last 10 lines of the /var/log/pan/masterd.log file.
username@hostname> tail /var/log/pan/masterd.log
[09:32:46] Successfully started process 'mgmtsrvr' instance '1'
[09:32:47] Successfully started process 'appWeb' instance '1'
[09:32:47] Started group 'pan' start script 'octeon' with options 'start'
[09:32:48] Process 'appWeb' instance '1' exited normally with status '7'
[09:32:48] Process 'appWeb' instance '1' has no further exit rules
[09:32:53] Successfully started process 'pan-ez-agent' instance '1'
[09:32:53] Process 'pan-ez-agent' instance '1' exited normally with status
'0'
[09:32:53] Process 'pan-ez-agent' instance '1' has no further exit rules
[09:32:54] Successfully started process 'pan_netconfig_agent' instance '1'
[09:32:54] Finished initial start of all processes
username@hostname>
target
target
Configures and shows a management session target.
Syntax
target {set <value> | show}
Options
> set Sets the target device
> show Shows the management session target
Sample Output
The following command displays the management session target.
username@hostname> target show
TBS
username@hostname>
tcpdump
tcpdump
Captures packets on the management interface.
Syntax
Use this command to performs packet captures on the management interface (MGT). This can be useful
to verify that traffic is traversing the interface and to analyze the traffic. Because this command defaults
to the MGT interface, there is no need to specify an interface.
Press ctrl-c to stop the capture. To view the capture results, run view-pcap mgmt-pcap
mgmt.pcap.
Syntax
tcpdump
{
filter value |
snaplen <value> |
{
Options
+ filter Apply TCP dump filters. The filter must be enclosed in quotes. For example, tcpdump filter
src net 67.207.148.0/24 and not port 22.
+ snaplen Define the packet capture snap length (0-65535). For example, to set 1500 bytes, run tcpdump
filter not port 22 snaplen 1500. Setting the snaplen to 0 will cause the firewall to use the
required length to capture whole packets. It is recommended to set the snaplen to the smallest value possible to
capture the protocol or packet.
test
test
Runs tests based on installed security policies.
Syntax
test
{
arp gratuitous {interface <interface_name> | ip <ip/netmask>} |
botnet domain <value> |
cp-policy-match {category <name> | destination <ip_address> | from <zone>
| source <ip_address> | to <zone>} |
custom-url rule <rule_name> url <value> |
data-filtering {ccn <value> | pattern <value> | ssn <value>} |
decryption-policy-match {application <name> | category <name> |
destination <ip_address> | from <zone> | source <ip_address> | to
<zone>} |
deployment-update-schedule refresh name <value> |
dns-proxy query name <name> source <ip_address> {domain-name <name> | ip
<ip_address>} |
dos-policy-match {destination <ip_address> | destination-port
<port_number> | from <zone> | from-interface <value> | protocol <value>
| source <ip_address> | source-user <value> | to <zone> | to-interface
<value>} |
global-protect-satellite {gateway-connect | gateway-disconnect | gatewayreconnect} gateway-address <value> method {activation | registration}
satellite <value> |
nat-policy-match {destination <ip_address> | destination-port
<port_number> | from <zone> | ha-device-id <value> | protocol <value> |
source <ip_address> | source-port <port_number> | to <zone> | tointerface <value>} |
nfs dynamic-logging-partition {port <port_number> | protocol {tcp | udp} |
readsize <value> | writesize <value> | logdirectory <value> | server
<ip/netmask>}
nd router-advertisement interface <value> |
pbf-policy-match {application <name> | destination <ip_address> |
destination-port <port_number> | from <zone> | from-interface <value> |
ha-device-id <value> | protocol <value> | source <ip_address> | sourceuser <value>} |
pppoe interface <interface_name> |
qos-policy-match {application <name> | destination <ip_address> |
destination-port <port_number> | from <zone> | protocol <value> |
source <ip_address> | source-user <value> | to <zone>} |
routing |
{
bgp virtual-router <name>
{
refresh peer <value> |
restart {peer <value> | self}
}
fib-lookup ip <ip_address> virtual-router <value>}
mfig-lookup group <ip/netmask> virtual-router <value> {source
test
<ip_address>} |
}
scp-server-connection |
{
confirm hostname <value> key <value> |
initiate hostname <value> password <value> username <value> {path
<value> | port <value>}
}
security-policy-match {application <name> | category <name> | destination
<ip_address> | destination-port <port_number> | from <zone> | protocol
<value> | show-all {no | yes} | source <ip_address> | source-user
<value> | to <zone>} |
stats-service |
tag-filter <value> |
url <value> |
url-cloud-traffic |
url-info-cloud <value> |
url-info-host <value> |
vpn |
{
ike-sa {gateway <value>} |
ipsec {tunnel <value>}
}
wildfire registration
}
Options
> arp Tests the Address Resolution Protocol (ARP) for the specified interface
* interface Sends gratuitous ARP for specific interface
* ip Sends gratuitous ARP to interface IP address (x.x.x.x/y or IPv6/netmask)
> botnet Tests botnet domain categorization
> cp-policy-match Tests captive portal policy matches
+ category URL category name (press <tab> for a list of category names)
+ destination Specifies the destination IP address (x.x.x.x or IPv6)
+ from Specifies the From zone
+ source Specifies the source IP address (x.x.x.x or IPv6)
+ to Specifies the To zone
> custom-url Tests custom URL categorization
* rule Specifies a security rule name
* url Specifies the URL value
> data-filtering Tests credit card number (CCN), social security number (SSN), or pattern matches
> ccn Specifies a credit card number
> pattern Specifies a pattern
> ssn Specifies a social security number
> decryption-policy-match Tests Secure Socket Layer (SSL) policy matches
+ application Specifies the application name to match (press <tab> for list)
+ category Specifies the category name to match (press <tab> for list)
+ destination Specifies the destination IP address (x.x.x.x or IPv6)
+ from Specifies the From zone
+ source Specifies the source IP address (x.x.x.x or IPv6)
+ to Specifies the To zone
> deployment-update-schedule Tests deployment update schedule operations
> refresh Runs the test
test
test
test
Sample Output
The following command tests whether the set of criteria matches any of the existing rules in the security
rule base.
username@hostname> test security-policy-match from trust to untrust
application google-talk source 10.0.0.1 destination 192.168.0.1 protocol
6 destination-port 80 source-user known-user
Matched rule: 'rule1' action: allow
username@hostname>
tftp export
tftp export
Uses Trivial File Transfer Protocol (TFTP) to export files from the firewall to another host. TFTP
export actions must specify the management interface IP as the source IP address. TFTP export actions
are not supported on in-band management ports.
Syntax
tftp export <option> {remote-port <port_number> | source-ip <ip_address>} to
<host>
{
application-block-page |
application-pcap from <file_name> |
captive-portal-text |
config-bundle |
configuration from <file_name> |
core-file {data-plane | management-plane} from <file_name> |
crl from <file_name> |
debug-pcap from <file_name> |
device-state |
file-block-continue-page |
file-block-page |
filter-pcap from <file_name> |
global-protect-portal-custom-help-page name <file_name> |
global-protect-portal-custom-login-page name <file_name> |
global-protect-portal-custom-welcome-page name <file_name> |
high-availability-key from <file_name> |
inbound-proxy-key from <value> |
log-file {data-plane | management-plane} |
mgmt-pcap from <file_name> |
ssl-cert-status-page |
ssl-optout-text |
stats-dump |
tech-support |
threat-pcap from <file_name> |
url-block-page |
url-coach-text |
virus-block-page |
web-interface-certificate
}
Options
+ remote-port TFTP server port number on remote host(1-65535)
+ source-ip Set source address to specified interface address (x.x.x.x or IPv6)
* to TFTP host
> application-block-page Exports application block comfort page
> application-pcap Exports application packet capture
> captive-portal-text Exports captive portal text
> config-bundle Exports configuration bundle
> configuration Exports configuration
> core-file Exports core file
> crl Exports crl.tgz
tftp export
> debug-pcap Exports packet capture generated for purpose of debugging daemons
> device-state Exports device state files from a GlobalProtect Portal
> file-block-continue-page Exports file block continue comfort page
> file-block-page Exports file block comfort page
> filter-pcap Exports filter packet capture
> global-protect-portal-custom-help-page Exports GlobalProtect help page
> global-protect-portal-custom-login-page Exports GlobalProtect login page
> global-protect-portal-custom-welcome-page Exports GlobalProtect welcome page
> high-availability-key Exports High Availability peer encryption key
> inbound-proxy-key Exports inbound proxy key
> log-file Exports log- file
> mgmt-pcap Exports packet capture from management interface
> ssl-cert-status-page Exports SSL certificate revoked notification page
> ssl-optout-text Exports SSL optout text
> stats-dump Exports log data base in CSV format
> tech-support Exports tech support info
> threat-pcap Exports threat packet capture
> url-block-page Exports URL block comfort page
> url-coach-text Exports URL coach text
> virus-block-page Exports virus block comfort page
> web-interface-certificate Exports web interface certificate
tftp import
tftp import
Uses Trivial File Transfer Protocol (TFTP) to import files to the firewall from another host. TFTP
import actions must specify the management interface IP as the destination IP address. TFTP import
actions are not supported on in-band management ports.
Syntax
tftp import <option> {remote-port <port_number> | source-ip <ip_address>}
file <source_path> from <host>
{
anti-virus |
application-block-page |
captive-portal-text |
certificate certificate-name <certificate_name> format {pem | pkcs12}
{passphrase <value>} |
configuration |
content |
device-state
file-block-continue-page |
file-block-page |
global-protect-client |
global-protect-portal-custom-help-page profile <profile_name> |
global-protect-portal-custom-login-page profile <profile_name> |
global-protect-portal-custom-welcome-page profile <profile_name> |
high-availability-key |
keypair certificate-name <certificate_name> format {pem | pkcs12}
passphrase <value> |
license |
private-key certificate-name <certificate_name> format {pem | pkcs12}
passphrase <value> |
signed-url-database |
software |
ssl-cert-status-page |
ssl-optout-text |
url-block-page |
url-coach-text |
url-database |
virus-block-page |
wildfire
}
Options
+ remote-port TFTP server port number on remote host(1-65535)
+ source-ip Set source address to specified interface address (x.x.x.x or IPv6)
* file Source path
* from TFTP host
> anti-virus Imports anti-virus content
> application-block-page Imports application block comfort page
> captive-portal-text Imports captive portal text
> certificate Imports X.509 certificate
tftp import
Sample Output
The following command imports a license file from a file in user1s account on the machine with IP
address 10.0.3.4.
username@hostname> tftp import ssl-certificate from [email protected]:/tmp/
certificatefile
username@hostname>
traceroute
traceroute
Displays information about the route packets take to another host.
Syntax
traceroute host <value>
{
bypass-routing {no | yes} |
debug-socket {no | yes} |
do-not-fragment {no | yes} |
first-ttl <value> |
gateway <value> |
ipv4 {no | yes} |
ipv6 {no | yes} |
max-ttl <value> |
no-resolve {no | yes} |
pause <value> |
port <value> |
source <ip_address> |
tos <value> {verbose} |
wait <value>
}
Options
+ bypass-routing Sends the request directly to the host on a direct attached network, bypassing usual routing
table
+ debug-socket Enables socket-level debugging
+ do-not-fragment Sets the do-not-fragment bit
+ first-ttl Sets the time-to-live (in number of hops) in the first outgoing probe packet
+ gateway Specifies a loose source router gateway (maximum = 8)
+ ipv4 Specifies that IPv4 is used
+ ipv6 Specifies that IPv6 is used
+ max-ttl Sets the maximum time-to-live in number of hops
+ no-resolve Does not attempt to print resolved domain names
+ pause Sets the time to pause between probes (in milliseconds)
+ port Sets the base port number used in probes (default for UDP = 33434; for TCP = 80; for ICMP = 1)
+ source Specifies the source IP address in outgoing probe packets
+ tos Specifies the type of service (TOS) treatment for the packets by way of the TOS bit for the IP header in the
ping packet (0-255)
+ wait Specifies a delay in transmission of the traceroute request (in seconds)
* host Specifies the IP address or name of the remote host (required)
traceroute
Sample Output
The following command displays information about the route from the firewall to www.google.com.
username@hostname> traceroute www.paloaltonetworks.com
traceroute to www.paloaltonetworks.com (72.32.199.53), 30 hops max, 38 byte
packets
1 10.1.0.1 (10.1.0.1) 0.399 ms 1.288 ms 0.437 ms
2 64.0.27.225.ptr.us.xo.net (64.0.27.225) 1.910 ms dsl027-186189.sfo1.dsl.speakeasy.net (216.27.186.189) 1.012 ms
64.0.27.225.ptr.us.xo.net (64.0.27.225) 1.865 ms
3 dsl027-182-001.sfo1.dsl.speakeasy.net (216.27.182.1) 16.768 ms 581.420
ms 64.3.142.37.ptr.us.xo.net (64.3.142.37) 219.190 ms
4 ge5-0-0.mar2.fremont-ca.us.xo.net (207.88.80.21) 228.551 ms 110.ge-0-00.cr1.sfo1.speakeasy.net (69.17.83.189) 12.352 ms ge5-0-0.mar2.fremontca.us.xo.net (207.88.80.21) 218.547 ms
5 ge-5-3-0.mpr3.pao1.us.above.net (209.249.11.177) 13.212 ms p4-00.rar2.sanjose-ca.us.xo.net (65.106.5.137) 273.935 ms 221.313 ms
6 p1-0.ir1.paloalto-ca.us.xo.net (65.106.5.178) 139.212 ms so-1-21.mpr1.sjc2.us.above.net (64.125.28.141) 13.348 ms p1-0.ir1.paloaltoca.us.xo.net (65.106.5.178) 92.795 ms
7 so-0-0-0.mpr2.sjc2.us.above.net (64.125.27.246) 12.069 ms
206.111.12.146.ptr.us.xo.net (206.111.12.146) 93.278 ms so-0-00.mpr2.sjc2.us.above.net (64.125.27.246) 556.033 ms
8 tbr1p013201.sffca.ip.att.net (12.123.13.66) 52.726 ms so-3-20.cr1.dfw2.us.above.net (64.125.29.54) 61.875 ms
tbr1p013201.sffca.ip.att.net (12.123.13.66) 58.462 ms
MPLS Label=32537 CoS=0 TTL=1 S=1
9
view-pcap
view-pcap
Displays the contents of packet capture files.
Syntax
view-pcap {application-pcap | debug-pcap | filter-pcap | threat-pcap}
<file_name>
{
absolute-seq {no | yes} |
delta {no | yes} |
follow {no | yes} |
hex {no | yes} |
hex-ascii {no | yes} |
hex-ascii-link {no | yes} |
hex-link {no | yes} |
link-header {no | yes} |
no-dns-lookup {no | yes} |
no-port-lookup {no | yes} |
no-qualification {no | yes} |
no-timestamp {no | yes} |
timestamp {no | yes} |
undecoded-NFS {no | yes} |
unformatted-timestamp {no | yes} |
verbose {no | yes} |
verbose+ {no | yes} |
verbose++ {no | yes}
}
Options
+ absolute-seq Display the absolute TCP sequence numbers
+ delta Display a delta (in micro-seconds) between the current and previous lines
+ follow Monitor a pcap file in real time
+ hex Display each packet (minus link header) in hex
+ hex-ascii Display each packet (minus link header) in hex and ASCII
+ hex-ascii-link Display each packet (including link header) in hex and ASCII
+ hex-link Display each packet (including link header) in hex
+ link-header Display the link-level header on each dump line
+ no-dns-lookup Do not convert host addresses to names
+ no-port-lookup Do not convert protocol and port numbers to names
+ no-qualification Do not print domain name qualification of host names
+ no-timestamp Do not print a timestamp
+ timestamp Print a timestamp proceeded by date
+ undecoded-NFS Print undecoded NFS handles
+ unformatted-timestamp Print an unformatted timestamp
+ verbose Display verbose output
+ verbose+ Display more verbose output
+ verbose++ Display the maximum output details
> application-pcap Display application packet capture file specified by name
> debug-pcap Display debug packet capture file specified by name
> filter-pcap Display filter packet capture file specified by name
> threat-pcap Display threat packet capture file specified by name
view-pcap
Sample Output
The following command displays the contents of the packet capture file /var/session/pan/filters/
syslog.pcap in ASCII and hex formats.
username@hostname> view-pcap hex-ascii /var/session/pan/filters/syslog.pcap
reading from file /var/session/pan/filters/syslog.pcap, link-type EN10MB
(Ethernet)
08:34:31.922899 IP 10.0.0.244.32884 > jdoe.paloaltonetworks.local.syslog:
UDP, length 314
0x0000: 4500 0156 0000 4000 4011 2438 0a00 00f4 E..V..@.@.$8....
0x0010: 0a00 006c 8074 0202 0142 d163 3c31 3137 ...l.t...B.c<117
0x0020: 3e41 7072 2020 3233 2030 383a 3334 3a33 >Apr..23.08:34:3
0x0030: 3420 312c 3034 2f32 3320 3038 3a33 343a 4.1,04/23.08:34:
0x0040: 3334 2c54 4852 4541 542c 7572 6c2c 312c 34,THREAT,url,1,
0x0050: 3034 2f32 3320 3038 3a33 343a 3235 2c31 04/23.08:34:25,1
0x0060: 302e 302e 302e 3838 2c32 3039 2e31 3331 0.0.0.88,209.131
0x0070: 2e33 362e 3135 382c 302e 302e 302e 302c .36.158,0.0.0.0,
0x0080: 302e 302e 302e 302c 6c32 2d6c 616e 2d6f 0.0.0.0,l2-lan-o
0x0090: 7574 2c77 6562 2d62 726f 7773 696e 672c ut,web-browsing,
0x00a0: 7673 7973 312c 6c32 2d6c 616e 2d74 7275 vsys1,l2-lan-tru
0x00b0: 7374 2c6c 322d 6c61 6e2d 756e 7472 7573 st,l2-lan-untrus
0x00c0: 742c 6574 6865 726e 6574 312f 3132 2c65 t,ethernet1/12,e
0x00d0: 7468 6572 6e65 7431 2f31 312c 466f 7277 thernet1/11,Forw
0x00e0: 6172 6420 746f 204d 696b 652c 3034 2f32 ard.to.Mike,04/2
0x00f0: 3320 3038 3a33 343a 3334 2c38 3336 3435 3.08:34:34,83645
0x0100: 372c 322c 3438 3632 2c38 302c 302c 302c 7,2,4862,80,0,0,
0x0110: 3078 302c 7463 7028 3629 2c61 6c65 7274 0x0,tcp(6),alert
0x0120: 2c77 7777 2e79 6168 6f6f 2e63 6f6d 2f70 ,www.yahoo.com/p
0x0130: 2e67 6966 3f2c 2c73 6561 7263 682d 656e .gif?,,search-en
0x0140: 6769 6e65 732c 696e 666f 726d 6174 696f gines,informatio
0x0150: 6e61 6c2c 3000
nal,0.
view-pcap
Chapter 5
up on page 667
Note: Changes in the configuration are retained, until overwritten, while the
firewall is powered. To save a candidate configuration in non-volatile storage, use
the save command. To make a candidate configuration active, use the commit
command.
check
check
Displays the current configuration status.
Syntax
check
{
data-access-passwd {system} |
pending-changes
}
Options
> data-access-passwd Check data access authentication status for this session
+ system Check whether data access password exists for the system
> pending-changes Check for uncommitted changes
Sample Output
The following command shows that there are currently no uncommitted changes.
username@hostname# check pending-changes
no
[edit]
username@hostname#
commit
commit
Makes the current candidate configuration the active configuration on the firewall.
Note: When you change a configuration setting, the current candidate
configuration is updated, not the active configuration. The commit command
applies the candidate configuration to the active configuration, which activates all
configuration changes since the last commit.
Syntax
commit
{
force
partial {
device-and-network excluded |
policy-and-objects excluded |
validate
}
Options
> force Forces the commit command in the event of a conflict
> partial Commits the specified part of the configuration
+ device-and-network Excludes device and network configurations from the commit (configurations under
config/mgt-config, config/devices/platform, config/devices/deviceconfig, and config/devices/network)
+ policy-and-object Excludes policy and object configurations from the commit (configurations under
(config/shared; also excludes config/devices/vsys if in single vsys mode)
> validate Validates the command prior to commit.
Sample Output
The following command updates the active configuration with the contents of the candidate
configuration.
username@hostname# commit
copy
copy
Makes a copy of a node in the hierarchy along with its children, and adds the copy to the same hierarchy
level.
Syntax
copy <node1> to <node2>
Options
<node1> Specifies the node to be copied
<node2> Specifies the name of the copy
Sample Output
The following command, copies policy1 to policy2.
username@hostname# copy policy policy1 to policy2
delete
delete
Removes a node from the candidate configuration along with all its children.
Note: No confirmation is requested when this command is entered.
Syntax
delete <node>
Options
<node> Specifies the node to be deleted. For available nodes of the hierarchy, press <tab>.
Sample Output
The following command deletes the icon label1 from the candidate configuration.
username@hostname# delete icon label1
[edit]
username@hostname#
edit
edit
Changes context to a lower level in the configuration hierarchy.
Syntax
edit <context>
Options
<context> Specifies a path through the hierarchy. For available contexts in the hierarchy, press <tab>.
Sample Output
The following command changes context from the top level to the mgt-config level of the hierarchy.
[edit]
username@hostname# edit mgt-config
[edit mgt-config]
username@hostname#
exit
exit
Exits from the current PAN-OS CLI level.
From Configuration mode, top hierarchy level Exits Configuration mode, returning to
Operational mode.
From Configuration mode, lower hierarchy levels Changes context to one level up in the
hierarchy. Provides the same result as the up command.
Note: The exit command is the same as the quit command.
Syntax
exit
Options
None
Sample Output
The following command changes to the profiles level and then changes context back to the top level.
username@hostname# edit profiles
[edit profiles]
username@hostname# exit
username@hostname#
find
find
Lists CLI commands containing the specified keyword.
Syntax
find command keyword <value>
Options
<value> Specifies a keyword.
Sample Output
The following command lists all CLI commands containing the keyword hsm.
username@hostname# find command keyword hsm
show deviceconfig system hsm-settings
show deviceconfig system hsm-settings provider
show deviceconfig system hsm-settings provider
show deviceconfig system hsm-settings provider
show deviceconfig system hsm-settings provider
show deviceconfig system hsm-settings provider
<name>
show deviceconfig system hsm-settings provider
...
username@hostname#
safenet-luna-sa
safenet-luna-sa hsm-server
safenet-luna-sa hsm-server
safenet-luna-sa ha
load
load
Assigns the last saved configuration, or a specified configuration, to be the candidate configuration.
Also, loads the last imported device state files.
Syntax
load
{
config |
{
key <value> |
from <filename> |
last-saved |
partial |
{
from <filename> |
from-xpath <value> |
mode {merge | replace} |
to-xpath <value>
}
repo device <value> {file <value> | version <value>} |
version <value>
}
device-state
}
Options
> config Loads specified configuration
+ key Key used for encryption
> from File name (select from the file names provided, or enter a new name)
> last-saved Loads the last saved configuration
> partial Loads partial configuration
* from File name (select from the file names provided, or enter a new name)
* from-xpath XML Path (XPath) of the source node
* mode Mode in which to load (merge or replace)
* to-xpath XML Path (XPath) of the destination's parent
> repo Loads device config from backup repository
* device Device name
> file Filename
> version Version
> version Selects from the provided versions
> device-state Loads from imported device state files to GlobalProtect Portals.
load
Sample Output
The following command assigns output.xml to be the candidate configuration.
[edit]
username@hostname# load config from output.xml
command succeeded
[edit]
username@hostname#
The following command adds the top-apps report found in the x.xml configuration to the specified
candidate configuration.
[edit]
username@hostname# load config partial from x.xml from-xpath shared/
reports/entry[@name='top-apps'] mode merge to-xpath/config/devices/
entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1']/reports
command succeeded
[edit]
username@hostname#
move
move
Relocates a node in the hierarchy along with its children to be at another location at the same hierarchy
level.
Syntax
move <element1> {bottom | top | after <element2> | before <element2>}
Options
<element1> Specifies the items to be moved. For available elements of the hierarchy, press <tab>.
<element2> Indicates the element after or before which element1 will be placed
after Moves element to be after element2
before Moves element to be before element2
bottom Makes the element the last entry of the hierarchy level
top Makes the element the first entry of the hierarchy level
Sample Output
The following command moves the policy policy1 to the top level.
username@hostname# move policy rule1 top
[edit]
username@hostname#
override
override
Overrides a node from the candidate configuration along with all its children. This is a device command
that overrides a value pushed from a Panorama Template.
Note: No confirmation is requested when this command is entered.
Syntax
override <node>
Options
<node> Specifies the node to override. For available nodes of the hierarchy, press <tab>.
Sample Output
The following command overrides an configuration profile with a specified web clip from the
candidate configuration.
username@hostname# override profiles android-configuration myconfig webclip myclip
[edit]
username@hostname#
quit
quit
Exits from the current PAN-OS CLI level.
From Configuration mode, top hierarchy level Exits Configuration mode, returning to
Operational mode.
From Configuration mode, lower hierarchy levels Changes context to one level up in the
hierarchy. Provides the same result as the up command.
Note: The exit and quit commands are interchangeable.
Syntax
quit
Options
None
Sample Output
The following command changes context from the network interface level to the network level.
[edit log-settings]
username@hostname# quit
[edit]
username@hostname#
rename
rename
Changes the name of a node in the hierarchy.
Syntax
rename <node1> to <node2>
Options
<node1> Indicates the original node name. For available nodes of the hierarchy, press <tab>.
<node2> Indicates the new node name
Sample Output
The following command changes the name of a policy from Policy1 to Policy2.
username@hostname# rename policy Policy1 to Policy2
run
run
Executes an Operational mode command while in Configuration mode.
For information about the syntax and options for each Operational mode command, refer to its
command page in Chapter 4, Operational Mode Commands.
Syntax
run
{
check |
debug |
delete |
grep |
less |
ls |
netstat |
ping |
request |
scp |
set |
show |
ssh |
tail |
test |
traceroute |
}
Sample Output
The following command executes a ping command to the IP address 1.1.1.2 from Configuration
mode.
username@hostname# run ping host 1.1.1.2
PING 1.1.1.1 (1.1.1.1) 56(84) bytes of data.
...
username@hostname#
save
save
Saves a snapshot of the firewall configuration or the device state files from a GlobalProtect Portal.
Note: This command saves the configuration on the firewall, but does not make
the configuration active. Use the commit command to make the current candidate
configuration active.
Syntax
save
{
config to <filename> |
device-state
}
Options
> config Saves the current configuration
+ to File name (select from the file names provided, or enter a new name)
> device-state Saves all files needed to restore a GlobalProtect Portal. This command is used to save the
configuration and dynamic information from a firewall that is configured as a GlobalProtect Portal with the
large scale VPN feature enabled. The file can then be imported to restore the Portal in the event of a failure.
The export contains a list of all satellite devices managed by the Portal, the running configuration at the time
of the export, and all certificate information (Root CA, Server, and Satellite certificates).
Sample Output
The following command saves a copy of the configuration to the file savefile.
[edit]
username@hostname# save config to savefile
Config saved to savefile
[edit]
username@hostname#
Syntax
set deviceconfig setting
}
custom-logo {
login-screen {
name <value>;
content <value>;
}
main-ui {
name <value>;
content <value>;
}
pdf-report-header {
name <value>;
content <value>;
}
pdf-report-footer {
name <value>;
content <value>;
}
{
jumbo-frame {
mtu 512-9216;
}
management {
auto-acquire-commit-lock {yes | no} |
enable-certificate-expiration-check {yes | no} |
hostname-type-in-syslog <value> |
idle-timeout <value> |
max-audit-versions <value> |
max-rows-in-csv-export <value> |
max-rows-in-pdf-report <value> |
admin-lockout {failed-attempts <value> | lockout time <value>} |
common-criteria-alarm-generation
(
enable-alarm-generation {yes | no} |
enable-audible-alarms {yes | no} |
enable-cli-alarm-notification {yes | no} |
enable-web-alarm-notification {yes | no} |
encrypt-decrypt-fail-count <value> |
log-databases-alarm-threshold
{
config <value> |
hipmatch <value> |
mdm <value> |
system <value> |
}
rule-group-limits
{
count <value> |
time-interval <value> |
tags <value> |
}
security-policy-limit
{
count <value> |
time-interval <value> |
}
disk-quota
{
alarm <float>;
config <float>;
hipmatch <float>;
mdm <float>;
system <float>;
}
util {
assert-crash-once yes|no;
}
{
Options
> setting
> custom-logo
> login-access Import custom logo for login screen (from content or file)
+ content Upload custom login screen page (base64 encoded)
+ name File name alphanumeric string [ 0-9a-zA-Z./_-]
> main-ui Import custom logo for main user interface (from content or file)
+ content Upload custom main user interface page (base64 encoded)
+ name File name alphanumeric string [ 0-9a-zA-Z./_-]
> pdf-report-footer Import custom logo for PDF report footers (from content or file)
+ content Upload custom PDF report footer page (base64 encoded)
+ name File name alphanumeric string [ 0-9a-zA-Z./_-]
> pdf-report-header Import custom logo for PDF report headers (from content or file)
+ content Upload custom lPDF report header page (base64 encoded)
+ name File name alphanumeric string [ 0-9a-zA-Z./_-]
> jumbo-frame
+ mtu device MTU excluding Ethernet header (512-9216)
> management
+ auto-acquire-commit-lock Automatically add a commit lock when modifying configuration
+ enable-certificate-expiration-check Check for expired certificates and stop using them
+ hostname-type-in-syslog Choose type to send in hostname field in syslog header (FSDN, hostname,
ipv4-address, or ipv6-address)
+ idle-timeout Default administrative session idle timeout in minutes (1-1440; 0 = never)
+ max-audit-versions Maximum number of audited versions of config to preserve (1-1048576)
+ max-rows-in-csv-export Maximum number of rows in exported csv files (1-1048576)
+ max-rows-in-pdf-report Maximum number of rows in user activity report (1-1048576)
> admin-lockout Administrative login lockout settings
+ failed-attempts Number of failed login attempts to trigger lock-out (0-10)
Sample Output
The following command locks an administrative user out for 15 minutes after 5 failed login attempts.
username@hostname# set deviceconfig setting management admin-lockout 5
lockout-time 15
Syntax
set deviceconfig system
{
authentication profile <value>;
certificate-profile <value>;
default-gateway <ip/netmask>;
domain <value>;
domain-lookup-url <value>;
hostname <value>;
ip-address <ip/netmask>;
ip-address-lookup-url <value>;
ipv6-address <ip/netmask>;
ipv6-default-gateway <ip/netmask>;
locale <value>;
login-banner <value>;
mtu <value>;
netmask <value>;
ntp-server-1 <value>;
ntp-server-2 <value>;
secure-proxy-password <value>;
secure-proxy-port <value>;
secure-proxy-server <value>;
secure-proxy-user <value>;
speed-duplex auto-negotiate|10Mbps-half-duplex|10Mbps-fullduplex|100Mbpshalf-duplex|100Mbps-full-duplex|1Gbps-full-duplex; link-state up|down;
service {
disable-http yes|no;
disable-https yes|no;
disable-telnet yes|no;
disable-ssh yes|no;
disable-icmp yes|no;
disable-snmp yes|no;
disable-mobile-device-checkin yes|no;
disable-globalprotect-gateway yes|no;
}
permitted-ip {
<address>;
}
}
speed-duplex auto-negotiate|10Mbps-half-duplex|10Mbps-fullduplex|100Mbps-half-duplex|100Mbps-full-duplex|1Gbps-halfduplex|1Gbps-full-duplex;
syslog-certificate <value>;
timezone <value>;
update-server <value>;
web-server-certificate <value>;
dns-setting {
servers {
primary <ip/netmask>;
secondary <ip/netmask>;
}
}
geo-location {
latitude <value>;
longitude <value>;
}
hsm-settings {
provider {
safenet-luna-sa {
hsm-server {
<name> {
server-address <ip/netmask>;
}
}
ha {
auto-recovery-retry 0-500;
ha-group-name <value>;
}
}
OR...
thales-nshield-connect {
hsm-server {
<name> {
server-address <ip/netmask>;
}
}
rfs-address <ip/netmask>;
}
OR...
none;
}
}
log-export-schedule {
<name> {
description <value>;
enable yes|no;
log-type device-state|hipmatch|mdm-log;
start-time <value>;
protocol {
ftp {
hostname <value>;
port 1-65535;
path <value>;
username <value>;
password <value>;
passive-mode yes|no;
}
OR...
scp {
hostname <value>;
port 1-65535;
path <value>;
username <value>;
password <value>;
}
}
}
log-link {
<name> {
url <value>;
}
}
ethernet1 {
default-gateway <ip>;
ip-address <ip>;
link-state up|down;
mtu <value>;
netmask <ip>;
speed-duplex auto-negotiate|10Mbps-half-duplex|10Mbpsfullduplex|100Mbps-half-duplex|100Mbps-full-duplex|1Gbps-fullduplex; link-state up|down;
permitted-ip <ip/netmask>;
service {
disable-globalprotect-gateway yes|no;
disable-http yes|no;
disable-https yes|no;
disable-mobile-device-checkin yes|no;
disable-ssh yes|no;
disable-icmp yes|no;
disable-snmp yes|no;
disable-telnet yes|no;
}
permitted-ip {
<address>;
}
route {
service {
<name> {
source {
interface <value>;
address <value>;
}
}
}
destination {
<address> {
source-address <value>;
}
}
}
service {
disable-globalprotect-gateway yes|no;
disable-http yes|no;
disable-https yes|no;
disable-mobile-device-checkin yes|no;
disable-ssh yes|no;
disable-icmp yes|no;
disable-snmp yes|no;
disable-telnet yes|no;
}
snmp-setting {
snmp-system {
location <value>;
contact <value>;
send-event-specific-traps yes|no;
}
access-setting {
version {
v2c {
snmp-community-string <value>;
}
OR...
v3 {
views {
<name> {
view {
<name> {
oid <value>;
option include|exclude;
mask <value>;
}
}
}
}
users {
<name> {
view <value>;
authpwd <value>;
privpwd <value>;
}
}
}
}
}
}
}
update-schedule {
statistics-service {
device {
software-crash-info yes|no;
}
}
app-profile {
recurring {
daily {
at <value>;
action download-only|download-and-install;
}
OR...
weekly {
day-of-week
sunday|monday|tuesday|wednesday|thursday|friday|saturday;
at <value>;
action download-only|download-and-install;
}
threshold 1-120;
}
}
global-protect-datafile {
recurring {
hourly {
at 0-59;
action download-and-install;
}
OR...
daily {
at <value>;
action download-and-install;
}
OR...
weekly {
day-of-week
sunday|monday|tuesday|wednesday|thursday|friday|saturday;
at <value>;
action download-and-install;
}
}
}
}
}
}
Options
> system
+ authentication-profile Authentication profile to use for non-local administrators (RADIUS method is
supported)
+ certificate-profile Profile for verifying client certificates
+ default-gateway Default gateway IP address
+ domain Domain value
+ domain-lookup-url Domain lookup URL
+ hostname Hostname value
+ ip-address IP address for the management interface
+ ip-address-lookup-url IP address lookup URL
+ ipv6-address IPv6/netmask for the management interface
+ ipv6-default-gateway IPv6 for the default gateway
+ locale System default locale (US, Japan, CN, or TW)
+ login-banner Login banner text
+ mtu Maximum Transmission Unit (MTU) for the management interface
+ netmask IP address or IPv6 for the management interface network mask
+ ntp-server-1 First Network Time Protocol (NTP) server IP address
+ ntp-server-2 Second Network Time Protocol server IP address
set directory-integration
set directory-integration
Configures directory integration.
Syntax
set directory-integration <name>
{
disabled yes|no;
group-filter <value>;
server-profile <value>;];
update-interval 60-86400;
use-modify-timestamp yes|no;
user-filter <value>;
container-object [ <container-object1> <container-object2>... ];
email [ <email1> <email2>... ];
group-include-list [ <group-include-list1> <group-include-list2>...
group-member [ <group-member1> <group-member2>... ];
group-name [ <group-name1> <group-name2>... ];
group-object [ <group-object1> <group-object2>... ];
last-modify-attr [ <last-modify-attr1> <last-modify-attr2>... ];
user-name [ <user-name1> <user-name2>... ];
user-object [ <user-object1> <user-object2>... ];
}
Options
<name> Specifies the display name for the system
+ disabled disabled (yes or no)
+ group-filter ldap search filter for group
+ server-profile LDAP server object
+ update-interval Interval (seconds) for updating group membership, default is 3600 seconds
+ use-modify-timestamp use-modify-timestamp
+ user-filter ldap search filter for user
> container-object container object class (start list of values)
> email email object class (start list of values)
> group-include-list include list (start list of values)
> group-member group member attribute (start list of values)
> group-name group name attribute (start list of values)
> group-object group object class (start list of values)
> last-modify-attr last modify timestamp attribute (start list of values)
> user-name user name attribute (start list of values)
> user-object user object class (start list of values)
set global-protect-mdm
set global-protect-mdm
Configures GlobalProtect Mobile Security Manager on the device. Mobile Security Manager provides
security for client systems, such as laptops, that are used in the field by allowing easy and secure login
from anywhere in the world.
Syntax
set global-protect-mdm
{
authentication-message <value>;
authentication-profile <value>;
check-in-interval 30-1440;
check-in-port 443|7443|8443;
consent-text <value>;
enrollment-port 443|7443|8443;
host <value>;
organization-identifier <value>;
organization-name <value>;
save-password yes|no;
server-certificate <value>;
server-certificate-ca <value>;
apns {
certificate <value>;
}
device-identity-certificate {
ca <value>;
days-till-expiry 60-3650;
renew-identity-certificate-display-msg <value>;
require-reenroll yes|no;
scep {
certificate-profile <value>;
scep <value>;
}
gateway {
certificate-profile <value>;
server-certificate <value>;
}
gcm {
api-key <value>;
sender-id <value>;
}
hip-collection {
exclude-gps-location yes|no;
}
hip-notification {
<name> {
match-message {
include-app-list yes|no;
message <value>;
}
not-match-message {
set global-protect-mdm
message <value>;
}
}
}
}
Options
> global-protect-mdm GlobalProtect Mobile Security Manager configuration
+ authentication-message Authentication profile used for this Mobile Security Manager
+ authentication-profile Authentication profile used for this Mobile Security Manager
+ check-in-interval Device check-in interval (minutes)
+ check-in port Device check-in port
+ consent-text Mobile Security Manager installation Consent Text
+ enrollment-port Device Enrollment Port
+ host Mobile Security Manager Host Name
+ organization-identifier Organization identifier
+ organization-name Organization name
+ save-password Whether save user's password into database
+ server-certificate SSL server certificate name
+ server-certificate-ca SSL server certificate's CA file name
> apns Configure APNS Parameters
+ certificate (specify name)
> device-identity-certificate Device identity certificate
+ ca CA for Client certificate
+ days-till-expiry Number of days till expiry for device identity certificate
+ renew-identity-certificate-display-msg Message to be displayed in the push notification on the
mobile device to renew enrollment
+ require-reenroll Requiring Re-enroll will force all device users to unenroll and enroll their devices
again with the Mobile Security Manager upon expiration of certificate issued during initial enrollment
> scep SCEP Configuration for IOS devices enrollment
+ certificate-profile Profile for authenticating client certificates
+ scep SCEP
> gateway Configure Gateway connections Parameters
+ certificate-profile Profile for authenticating client certificates
+ server-certificate Server Certificate for Connections from Gateways
> gcm Configure GCM Parameters
+ api-key GCM API Key
+ sender-id GCM Sender ID
> hip-collection Host information profile collection instructions
+ exclude-gps-location Exclude GPS Location
> hip-notification host PC health evaluate (specify value)
set icon
set icon
Configures an icon for mobile devices.
Syntax
set icon <name>
{
description <value> |
image <name> |
}
Options
<name> Name to identify the icon
+ description Icon description
+ image Icon image
set mgt-config
set mgt-config
Configures management accounts on the firewall.
Syntax
set mgt-config
{
devices <serial_number> |
{
disable-config-backup {no | yes} |
hostname <value> |
ip <value>
}
password-complexity |
{
block-repeated-characters <value> |
block-username-inclusion {no | yes} |
enabled {no | yes} |
minimum-length <value> |
minimum-lowercase-letters <value> |
minimum-numeric-letters <value> |
minimum-special-characters <value> |
minimum-uppercase-letters <value> |
new-password-differs-by-characters <value> |
password-change-on-first-login {no | yes} |
password-change-period-block <value> |
password-history-count <value> |
password-change
{
expiration-period <value> |
expiration-warning-period <value> |
post-expiration-admin-login-count <value> |
post-expiration-grace-period <value>
}
}
password-profile <name> |
{
password-change
{
expiration-period <value> |
expiration-warning-period <value> |
post-expiration-admin-login-count <value> |
post-expiration-grace-period <value>
}
}
test test-config <name>
users <name>
{
authentication-profile <profile_name> |
client-certificate-only {no | yes} |
password-profile <value> |
set mgt-config
public-key <value> |
permissions role-based |
{
deviceadmin <name> |
devicereader <name> |
custom |
{
profile <name> |
}
superreader yes |
superuser yes |
}
phash <value> |
preferences |
{
disable-dns {no | yes} |
saved-device-query {
device <name> query <value>
}
saved-log-query
{
alarm <name> query <query_value> |
config <name> query <query_value> |
data <name> query <query_value> |
hipmatch <name> query <query_value> |
mdm <name> query <query_value> |
system <name> query <query_value> |
}
}
password
}
Options
> devices (Panorama only) Device serial number
+ disable-config-backup Enable config back up for this device
+ hostname Device ost name
+ ip Device IP address
> password-complexity Password complexity settings
+ block-repeated-characters Block repeated characters count (0-15)
+ block-username-inclusion Block inclusion of username and it's reverse
+ enabled Enable minimal password complexity enforcement
+ minimum-length Minimum password length (0-15)
+ minimum-lowercase-letters Minimum lowercase letters in the password (0-15)
+ minimum-numeric-letters Minimum numeric characters in the password (0-15)
+ minimum-special-characters Minimum special characters (non-alphanumeric) in the password (0-15)
+ minimum-uppercase-letters Minimum uppercase letters in the password (0-15)
+ new-password-differs-by-characters New Password must differ by the count chars (0-15)
+ password-change-on-first-login Password must change on first time login
+ password-change-period-block Password change block period, in days (0-365)
+ password-history-count Save password history for password changes, in days (0-150)
> password-change Password change settings
+ expiration-period Password expiry, in days (0-365)
+ expiration-warning-period Password expiry warning period, in days (0-30)
set mgt-config
set policy
set policy
Specifies settings for mobile device policies.
Syntax
set policy
{
<name> {
disabled yes|no;
android-profiles [ <android-profiles1> <android-profiles2>... ];
hip-profiles [ <hip-profiles1> <hip-profiles2>... ];
ios-profiles [ <ios-profiles1> <ios-profiles2>... ];
users [ <users1> <users2>... ];
}
}
Options
<name> Profile group to configure
+ disabled Disable the rule
> android-profiles Android profiles (name)
> hip-profiles HIP profiles (name)
> ios-profiles IOS profiles (name)
> users Specify user
set profiles
set profiles
Specifies settings for security profiles that can be applied to security policies for mobile devices.
Syntax
set profiles
{
android-configuration <name>
{
description <value>;
identifier <value>;
name <value>;
passcode {
auto-lock 1-60;
max-failed-attempts 4-10;
min-passcode-len 1-16;
passcode-history 1-50;
passcode-type {
password |
min-complex-len 1-4;
pin
}
restrictions {
allow-camera yes|no;
require-encrypted-storage yes|no;
}
web-clip {
<name> {
label <value>;
url <value>;
icon <value>;
}
wifi <name>
{
auto-join yes|no;
hidden yes|no;
service-id <value>;
proxy-setup {
manual {
port 1-65535;
address <value>;}
}
security-type {
any {password <value>;
wep {
password <value>;
}
any-enterprise {
accepted-eap {
eap-pwd | peap | tls | ttls {inner-identity
NONE|GTC|PAP|MSCHAP|MSCHAPv2;}
}
set profiles
password {
fixed <value> |
set-on-device |
use-saved;
}
trusted-certificates [ <trusted-certificates1> <trustedcertificates2>... ];
username {
fixed <value> |
set-on-device |
use-saved;
}
none |
wep password <value> |
wep-enterprise {
accepted-eap {
eap-pwd | peap | tls | ttls {inner-identity
NONE|GTC|PAP|MSCHAP|MSCHAPv2;}
}
password {
fixed <value> |
set-on-device |
use-saved;
}
trusted-certificates [ <trusted-certificates1> <trustedcertificates2>... ];
username {
fixed <value> |
set-on-device |
use-saved;
}
wpa password <value> |
wpa-enterprise {
accepted-eap {
eap-pwd | peap | tls | ttls {inner-identity
NONE|GTC|PAP|MSCHAP|MSCHAPv2;}
}
password {
fixed <value> |
set-on-device |
use-saved;
}
trusted-certificates [ <trusted-certificates1> <trustedcertificates2>... ];
username {
fixed <value> |
set-on-device |
use-saved;
}
}
hip-objects <name> {
description <value>;
applications {
criteria {
set profiles
set profiles
tag {
contains <value> |
is <value> |
is-not <value>
}
}
}
settings {
criteria {
disk-encrypted <no | yes> |
jailbroken <no | yes> |
passcode-set <no | yes>
}
}
hip-profiles <name>
{
description <value>;
match <value>;
}
ios-configuration <name>
{
description <value>;
identifier <value>;
name <value>;
activesync {
<name> {
account-name <value>;
allow-move yes|no;
domain <value>;
enable-address-syncing yes|no;
past-days-to-sync 0|1|3|7|14|31;
server <value>;
use-only-in-mail yes|no;
use-ssl yes|no;
email-address {
fixed <value> |
use-saved-username <value> |
from-directory-server
}
enable-smime yes|no;
}
identity-certificate {
certificate <value> |
scep <value>;
}
password {
fixed <value> |
set-on-device |
use-saved;
}
username {
fixed <value> |
use-saved
}
apn {
access-point-name <value>;
set profiles
proxy-server <value>;
proxy-port 1-65535;
password {
fixed <value> |
set-on-device |
use-saved;
}
username {
fixed <value> |
set-on-device |
use-saved
}
auto-remove-profile {
duration-until-removal 1-65535;
never |
removal-date <value> |
}
certificates <name> {
password <value>;
}
email <name> {
account-description <value>;
allow-move yes|no;
enable-address-syncing yes|no;
use-only-in-mail yes|no;
account-type {
pop |
imap {
path-prefix <value>;
}
email-address {
fixed <value> |
use-saved-username <value> |
from-directory-server;
}
enable-smime yes|no;
incoming {
authentication-type
EmailAuthNone|EmailAuthPassword|EmailAuthCRAMMD5|EmailAuthNTL
M|EmailAuthHTTPMD5;
port <value>
password {
fixed <value> |
set-on-device |
use-saved
}
server <value>;
username {
fixed <value> |
use-saved
}
use-ssl yes|no;
}
outgoing {
authentication-type
set profiles
EmailAuthNone|EmailAuthPassword|EmailAuthCRAMMD5|EmailAuthNTL
M|EmailAuthHTTPMD5;
port <value>
password {
fixed <value> |
set-on-device |
use-saved
}
server <value>;
username {
fixed <value> |
use-saved
}
use-ssl yes|no;
}
user-display-name {
fixed <value> |
use-saved
}
}
ldap {
<name> {
account-description <value>;
account-host <value>;
use-ssl yes|no;
password {
fixed <value> |
set-on-device |
use-saved
}
search-settings <name> {
base <value>;
scope
{LDAPSearchSettingScopeSubtree|LDAPSearchSettingScopeBase|LDAPS
earchSettingScopeOneLevel;
}
}
username {
fixed <value> |
set-on-device |
use-saved;
}
}
passcode {
allow-simple-value yes|no;
auto-lock none|1|2|3|4|5|10|15;
grace-period none|0|1|5|15|60|240;
max-failed-attempts 4-10;
max-passcode-age 1-730;
min-complex-len 1-4;
min-passcode-len 1-16;
passcode-history 1-50;
require-alphanumeric-value yes|no;
}
set profiles
restrictions {
accept-cookies 0|1|2;
allow-installing-apps yes|no;
allow-camera yes|no;
allow-facetime yes|no;
allow-screen-capture yes|no;
allow-auto-sync-when-roaming yes|no;
allow-siri yes|no;
allow-siri-while-locked yes|no;
allow-voice-dialing yes|no;
allow-in-app-purchase yes|no;
allow-multiplayer-gaming yes|no;
allow-adding-game-center-friends yes|no;
allow-youtube yes|no;
allow-itunes yes|no;
allow-safari yes|no;
allow-safari-autofill yes|no;
allow-icloud-backup yes|no;
allow-icloud-doc-sync yes|no;
allow-photo-stream yes|no;
allow-diagnostics-submission yes|no;
allow-untrusted-TLS-certificate yes|no;
allow-explicit-content yes|no;
allow-app-removal yes|no;
allow-bookstore yes|no;
allow-bookstore-erotica yes|no;
allow-chat yes|no;
allow-game-center yes|no;
allow-passbook-while-locked yes|no;
allow-shared-stream yes|no;
allow-configuration-profile-installation yes|no;
block-pop-ups yes|no;
enable-safari-javascript yes|no;
enable-siri-profanity-filter yes|no;
force-encrypted-backup yes|no;
force-itunes-password yes|no;
}
security {
always |
never |
with-authorization {
authorization-password <value>;
}
}
vpn <name> {
connection-name <value>;
server <value>;
account {
fixed <value> |
set-on-device |
use-saved;
}
proxy-setup
{
automatic url <value> |
set profiles
manual
{
address <value>;
port <value>;
password <value>;
username <value>
}
}
type {
anyconnect {
group <value>;
user-authentication {
password {
fixed <value> |
set-on-device |
use-saved
}
aruba user-authentication {
credential {
type {
scep <value> |
certificate <value>
}
vpn-on-demand {
domains {
<name> {
domain <value>;
action always|never|ondemand;
}
}
password {
fixed <value> |
set-on-device |
use-saved;
}
}
custom {
identifier <value>;
data {
<name> {
value <value>;
}
}
user-authentication {
password {
fixed <value> |
set-on-device |
use-saved
}
credential {
type {
scep <value> |
certificate <value>
}
f5-ssl {
credential {
type {
set profiles
scep <value> |
certificate <value>
}
vpn-on-demand {
domains {
<name> {
domain <value>;
action always|never|ondemand;
}
}
password {
fixed <value> |
set-on-device |
use-saved;
}
}
globalprotect {
allow-portal-profile yes|no;
user-authentication {
credential {
type {
scep <value> |
certificate <value>
}
vpn-on-demand {
domains {
<name> {
domain <value>;
action always|never|ondemand;
}
}
password {
fixed <value> |
set-on-device |
use-saved;
}
vpn-on-demand {
domains {
<name> {
domain <value>;
action always|never|ondemand;
}
}
l2tp {
send-all yes|no;
shared-secret <value>;
authenticate-type {
password |
rsa-securid;
}
}
ipsec machine-authentication {
shared-secret {
group-name <value>;
use-hybrid-auth yes|no;
prompt-for-password yes|no;
set profiles
shared-secret <value>;
}
credential {
include-user-pin yes|no;
type {
scep <value> |
certificate <value>;
}
vpn-on-demand {
domains {
<name> {
domain <value>;
action always|never|ondemand;
}
juniper-ssl {
realm <value>;
role <value>;
user-authentication {
password {
fixed <value> |
set-on-device |
use-saved;
}
credential {
type {
scep <value> |
certificate <value>;
}
vpn-on-demand {
domains {
<name> {
domain <value>;
action always|never|ondemand;
}
}
}
}
pptp {
authenticate-type {
password |
rsa-securid;
}
encryption-level none|automatic|maximum;
send-all yes|no;
}
sonicwall {
domain <value>;
user-authentication {
password {
fixed <value> |
set-on-device |
use-saved;
}
credential {
type {
scep <value> |
certificate <value>;
}
set profiles
vpn-on-demand {
domains {
<name> {
domain <value>;
action always|never|ondemand;
}
}
}
web-clip <name> {
full-screen yes|no;
icon <value>;
label <value>;
removable yes|no;
precomposed yes|no;
url <value>;
}
}
wifi <name> {
auto-join yes|no;
hidden yes|no;
service-id <value>;
proxy-setup {
automatic {
url <value>;
}
manual {
address <value>;
password {
fixed <value>;
OR...
set-on-device;
OR...
use-saved;
}
port 1-65535;
username {
fixed <value>;
OR...
set-on-device;
OR...
use-saved;
}
}
security-type {
any {password <value>;
wep {
password <value>;
}
any-enterprise {
accepted-eap {
eap-pwd | peap | tls | ttls {inner-identity
NONE|GTC|PAP|MSCHAP|MSCHAPv2;}
}
password {
fixed <value> |
set-on-device |
set profiles
use-saved;
}
trusted-certificates [ <trusted-certificates1> <trustedcertificates2>... ];
username {
fixed <value> |
set-on-device |
use-saved;
}
none |
wep password <value> |
wep-enterprise {
accepted-eap {
eap-pwd | peap | tls | ttls {inner-identity
NONE|GTC|PAP|MSCHAP|MSCHAPv2;}
}
password {
fixed <value> |
set-on-device |
use-saved;
}
trusted-certificates [ <trusted-certificates1> <trustedcertificates2>... ];
username {
fixed <value> |
set-on-device |
use-saved;
}
wpa password <value> |
wep-enterprise {
accepted-eap {
eap-pwd | peap | tls | ttls {inner-identity
NONE|GTC|PAP|MSCHAP|MSCHAPv2;}
}
password {
fixed <value> |
set-on-device |
use-saved;
}
trusted-certificates [ <trusted-certificates1> <trustedcertificates2>... ];
username {
fixed <value> |
set-on-device |
use-saved;
}
}
ios-provisioning {
<name> {
app-identifier <value>;
creation-date <value>;
expiration-date <value>;
profile <value>;
profile-identifier <value>;
set profiles
}
scep {
fingerprint <value>;
keysize 1024|2048;
name <value>;
nt-principal-name <value>;
retries 0-10;
retry-delay 0-36000;
scep-url <value>;
subject <value>;
subject-alternative-name-type
None|rfc822Name|dNSName|uniformResourceIdentifier;
subject-alternative-name <value>;
use-as-digital-signature yes|no;
use-for-key-encipherment yes|no;
scep-challenge {
none |
fixed <value> |
dynamic {
otp-server-path <value>;
password <value>;
username <value>;
}
use-ssl {
yes {
scep-ca-cert <value>;
scep-client-cert <value>;
} |
no;
}
}
Options
> android-configuration Android Configuration Profiles (specify name)
+ description Brief explanation of the contents or purpose of the profile
+ identifier Unique identifier for the profile
+ name Display name of the profile (shown on the device)
> passcode Passcode configuration
+ auto-lock Device automatically locks when time period elapses
+ max-failed-attempts Number of passcode entry attempts allowed before all data on device will be
erased
+ min-passcode-len Smallest number of passcode characters allowed
+ passcode-history Number of unique passcodes before reuse
> passcode-type passcode-type
> password Require passcodes to contain at least one letter
+ min-complex-len Smallest number of non-alphanumeric characters allowed
pin Permit the use of only numbers
> restrictions Restrictions configuration
+ allow-camera Allow use of camera
+ require-encrypted-storage Require encryption of stored data
> web-clip
Web Clip (name)
+ icon The icon to use for the Web Clip
+ label The name to display for the Web Clip
set profiles
set profiles
set profiles
set profiles
+ allow-app-removal
Allow removing apps (Supervised Only)
+ allow-auto-sync-when-roaming
Allow automatic sync while roaming
+ allow-bookstore
Allow Bookstore (Supervised Only)
+ allow-bookstore-erotica
Allow Erotica (Supervised Only)
+ allow-camera
Allow use of camera
+ allow-chat
Allow iMessage (Supervised Only)
+ allow-configuration-profile-installation Allow Configuration Profile Installation (Supervised Only)
+ allow-diagnostics-submission
Allow diagnostic data to be sent to Apple
+ allow-explicit-content
Allow explicit music, podcasts and iTunes U
+ allow-facetime
Allow FaceTime
+ allow-game-center
Allow use of Game Center (Supervised Only)
+ allow-icloud-backup
Allow iCloud backup
+ allow-icloud-doc-sync
Allow iCloud document sync
+ allow-in-app-purchase
Allow In-App Purchase
+ allow-installing-apps
Allow installing apps
+ allow-itunes
Allow use of iTunes Store
+ allow-multiplayer-gaming
Allow multiplayer gaming
+ allow-passbook-while-locked
Allow Passbook notifications while locked
+ allow-photo-stream
Allow Photo Stream (disabling can cause data loss)
+ allow-safari
Allow use of Safari
--more-+ allow-safari-autofill
Enable autofill
+ allow-screen-capture
Allow screen capture
+ allow-shared-stream
Allow Shared Photo Streams
+ allow-siri
Allow Siri
+ allow-siri-while-locked
Allow Siri while device locked
+ allow-untrusted-TLS-certificate
Allow user to accept untrusted TLS certificates
+ allow-voice-dialing
Allow voice dialing
+ allow-youtube
Allow use of YouTube
+ block-pop-ups
Block pop-ups
+ enable-safari-javascript
Enable JavaScript
+ enable-siri-profanity-filter
Enable Siri Profanity Filter (Supervised Only)
+ force-encrypted-backup
Force encrypted backups
+ force-itunes-password
Require iTunes Store password for all purchases
+ force-safari-fraud-warning
Force fraud warning
> security
Controls when the profile can be removed
> with-authorization with-authorization
always
always
never
never
> vpn
VPN
+ connection-name Display name of the connection (displayed on the device)
+ server
Hostname or IP address for server
> account
User account for authenticating the connection
> proxy-setup
Configures Proxies to be used with VPN connection
> type
The type of connection enabled by this policy
> web-clip
Web Clip
+ full-screen Displays the web clip as a full screen application
+ icon
The icon to use for the Web Clip
+ label
The name to display for the Web Clip
+ precomposed The icon will be displayed with no added visual effects
+ removable Enable removal of the Web Clip
+ url
The URL to be displayed when opening the Web Clip
> wifi
wifi configuration
+ auto-join
Automatically join the network
set profiles
+ hidden
Enable if network is not open or is not broadcasting
+ service-id
identification of wireless network to connect to
> proxy-setup Configures Proxies to be used with this network
> security-type Wireless network authentication and encryption
> ios-provisioning
iOS Provisioning Profiles (specify value)
+ app-identifier
app-identifier
+ creation-date
creation-date
+ expiration-date
expiration-date
+ profile
profile
+ profile-identifier profile-identifier
> scep scep (specify value)
+ fingerprint
Hex String to use as a fingerprint
+ keysize
Key size in bits
+ name
Name of the SCEP server
+ nt-principal-name
An NT principal name for use in the certificate request
+ retries
Number of times to retry after a PENDING response
+ retry-delay
Number of seconds to wait before each retry
+ scep-url
The base URL for the SCEP server
+ subject
Representation of a X.500 name
+ subject-alternative-name
The value of a subject alternative name
+ subject-alternative-name-type The type of a subject alternative name
+ use-as-digital-signature
Use as digital signature
+ use-for-key-encipherment
Use for key encipherment
> scep-challenge
Challenge for SCEP server configuration on mobile clients
set setting
set setting
Configures limits on device resources.
Syntax
set setting resource max-devices <value>
Options
> resource Limits on resources used by this vsys
+ max-devices Maximum number of devices allowed
Syntax
set shared admin-role <name>
{
description <value> |
role
{
device
{
cli {deviceadmin | devicereader | superreader | superuser} |
webui
{
commit {disable | enable | read-only} |
dashboard {disable | enable | read-only} |
devices {disable | enable | read-only} |
device-actions <value> {disable | enable | read-only} |
monitor
{
view-custom-reports {disable | enable | read-only} |
custom-reports
{
hipmatch {disable | enable | read-only} |
hostinfo {disable | enable | read-only} |
}
logs
{
configuration {disable | enable | read-only} |
hipmatch {disable | enable | read-only} |
mdm {disable | enable | read-only} |
system {disable | enable | read-only} |
pdf-reports {
email-scheduler {disable | enable | read-only} |
manage-pdf-summary {disable | enable | read-only} |
pdf-summary-reports {disable | enable | read-only} |
report-groups {disable | enable | read-only} |
}
policies {
policy-rulebase {disable | enable | read-only} |
configurations {
android {disable | enable | read-only} |
ios {disable | enable | read-only} |
provisioning-profiles {disable | enable | read-only} |
scep {disable | enable | read-only} |
web-clip-icons {disable | enable | read-only} |
}
privacy {disable | enable} |
show-full-ip-address {disable | enable} |
show-user-names-in-logs-and-reports {disable | enable} |
}
setup {
admin-roles {disable | enable | read-only} |
administrators {disable | enable | read-only} |
authentication-profile {disable | enable | read-only} |
authentication-sequence {disable | enable | read-only} |
config-audit {disable | enable | read-only} |
dynamic-updates {disable | enable | read-only} |
licenses {disable | enable | read-only} |
master-key {disable | enable | read-only} |
network {disable | enable | read-only} |
scheduled-log-export {disable | enable | read-only} |
settings {disable | enable | read-only} |
software {disable | enable | read-only} |
support {disable | enable | read-only} |
tags {disable | enable | read-only} |
virtual-systems {disable | enable | read-only} |
certificate-management {
certificate-profile {disable | enable | read-only} |
certificates {disable | enable | read-only} |
}
log-settings {
config {disable | enable | read-only} |
hipmatch {disable | enable | read-only} |
manage-log {disable | enable | read-only} |
mdm {disable | enable | read-only} |
system {disable | enable | read-only} |
}
server-profile
email {disable | enable | read-only} |
kerberos {disable | enable | read-only} |
ldap {disable | enable | read-only} |
radius {disable | enable | read-only} |
snmp-trap {disable | enable | read-only} |
syslog {disable | enable | read-only} |
}
user-database {
directory-integration {disable | enable | read-only} |
user-groups {disable | enable | read-only} |
users {disable | enable | read-only} |
}
}
xmlapi
{
commit {disable | enable} |
config {disable | enable} |
export {disable | enable} |
import {disable | enable} |
log {disable | enable} |
op {disable | enable} |
report {disable | enable} |
}
}
Options
<name> Shared administrative role name
+ description Description text
> role Sets access and responsibilities for the role
> device Device settings
+ cli Command Line Interface access
- deviceadmin Device Administrator
- devicereader Device Reader
- superreader Super Reader
- superuser Super User
> webui Sets enable, disable, or read-only access to the web user interface
+ commit Commit
+ dashboard Dashboard
+ devices Devices (enable/disable)
> device-actions Device settings
+ check-in
+ delete Admin roles
+ import Administrators
+ locate Authentication profile
+ lock Authentication sequence
+ message Block pages
+ push-policy Configuration audit
+ show-pending Dynamic updates
+ tag GlobalProtect Client
+ unenroll High Availability
+ unlock Licenses
+ view-imported Disable, enable, or read-only device master key
+ wipe Password profiles
> monitor Monitor settings
+ view-custom-reports View custom reports (enable/disable)
> custom-reports Custom report settings
+ hipmatch hipmatch report
+ hostinfo host info report
> logs Logs settings
+ configuration Configuration logs
+ hipmatch HIPmatch logs
+ mdm Mobile Security Manager logs
+ system System logs
> pdf-reports PDF reports
+ email-scheduler Email scheduler
+ manage-pdf-summary manage PDF summary
+ pdf-summary-reports PDF summary reports
+ report-groups Report groups
> policies Policy settings
+ policy-rulebase Application override rulebase
> configurations Policy configurations
+ android Enabled/disable/read-only
+ ios Enabled/disable/read-only
+ provisioning-profiles Enabled/disable/read-only
+ scep Enabled/disable/read-only
+ web-clip-icons Enabled/disable/read-only
> hip
+ data-collection Enabled/disable/read-only
+ hip-notifications Enabled/disable/read-only
+ hip-objects Enabled/disable/read-only
+ hip-profiles Enabled/disable/read-only
> privacy Privacy settings
+ show-full-ip-addresses Show full IP addresses
+ show-user-names-in-logs-and-reports Show user names in logs and reports
> setup Other setup settings (enable/disable/read-only)
+ admin-roles
+ administrator
+ authentication-profile
+ authentication-sequence
+ config-audit
+ dynamic-updates
+ licenses
+ master-key
+ network
+ scheduled-log-export
+ settings
+ software
+ support
+ tags
+ virtual-systems
> certificate-management
+ certificate-profile
+ certificates
> log-settings
+ config
+ hipmatch
+ manage-log
+ mdm
+ system
> server-profile
+ email
+ kerberos
+ ldap
+ radius
+ snmp-trap
+ syslog
> user-database
+ directory-integration
+ user-groups
+ users
> xmlapi Sets enable or disable access to the XML API user interface
+ commit Commit
+ config Configuration
+ export Export
+ import Import
+ log Log
+ op Operation
+ report Report
+ user-id User ID
Syntax
set shared authentication-profile <group_name> |
{
allow-list {all | <value>} |
lockout |
{
failed-attempts <value> |
lockout-time <minutes>
}
method
{
kerberos {server-profile <object_name>} |
ldap |
{
login-attribute <value> |
passwd-exp-days <value> |
server-profile <name>
}
radius {server-profile <object_name>}
local-database |
none
}
}
Options
<group_name> Specify group to share the profile
+ allow-list List of allowed users and groups enclosed in [ ]; option to specify all
> lockout Network user login lockout settings
+ failed-attempts Number of failed login attempts to trigger lock-out
+ lockout-time Number of minutes to lock-out
> method method
> kerberos Kerberos authentication
+ server-profile Kerberos server profile object
> ldap Lightweight Directory Access Protocol (LDAP) authentication
+ login-attribute Login attribute in LDAP server to authenticate against; default = uid
+ passwd-exp-days Days until the password expires
+ server-profile LDAP server profile object
> radius Remote Authentication Dial In User Service (RADIUS) authentication
+ server-profile RADIUS server profile object
- local-database Local database authentication
- none No authentication
Syntax
set shared authentication-sequence <name>
{
authentication-profiles <value> |
lockout
{
failed-attempts <value> |
lockout-time <value>
}
}
Options
<name> Authentication sequence name
+ authentication-profiles Authentication profiles to apply in the sequence (name or list of names enclosed in [ ])
> lockout Network user login lockout settings
+ failed-attempts Number of failed login attempts to trigger lock-out (0-10)
+ lockout-time Number of minutes to lock-out (0-60)
Syntax
set shared certificate <name> |
{
common-name <value> |
expiry-epoch <value> |
issuer <value> |
issuer-hash <value> |
not-valid-after <value> |
not-valid-before <value> |
revoke-date-epoch <value> |
status {revoked | valid} |
subject <value> |
subject-hash <value> |
csr <value> |
private-key <value> |
public-key <value>
}
Options
<name> Shared certificate name
+ common-name Common name value
+ expiry-epoch Expiry epoch value
+ issuer Issuer value
+ issuer-hash Issuer-hash value
+ not-valid-after Not-valid-after value
+ not-valid-before Not-valid-before value
+ revoke-date-epoch Revoke date epoch value
+ status Status (revoked or valid)
+ subject Subject value
+ subject-hash Subject-hash value
> csr Certificate Signing Request (CSR) value
> private-key Private key value
> public-key Public key value
Syntax
set shared certificate-profile <name> |
{
cert-status-timeout <value> |
crl-receive-timeout <value> |
domain <name> |
ocsp-receive-timeout <value> |
use-crl {no | yes} |
use-ocsp {no | yes} |
CA <name> |
{
default-ocsp-url <value> |
ocsp-verify-ca <value>
}
username-field
{
subject common-name |
subject-alt {email | principal-name}
}
}
Options
<name> Profile name
+ cert-status-timeout Set certificate status query timeout value in seconds (0-60)
+ crl-receive-timeout Set CRL receive timeout value in seconds (0-60)
+ domain Domain name (alphanumeric string [ 0-9a-zA-Z._-])
+ ocsp-receive-timeout Set OCSP receive timeout value in seconds (0-60)
+ use-crl Use Certificate Revocation List (CRL)
+ use-ocsp Use Online Certificate Status Protocol (OCSP)
> CA Certificate Authority (CA) name
+ default-ocsp-url Default URL for OCSP verification
+ ocsp-verify-ca CA file for OCSP response verify
> username-field User name field population
> subject Get user name from subject
> subject-alt Get user name from subject alternative name (email or principal name)
Syntax
set shared email-scheduler <name>
{
email-profile <value> |
recipient-emails <value> |
report-group <value> |
recurring
{
weekly {friday | monday | saturday | sunday | thursday | tuesday |
wednesday} |
daily |
disabled
}
}
Options
<name> Specifies the name for the email scheduler
+ email-profile Email profile value
+ recipient-emails Recipient emails value
+ report-group Report group value
> recurring Recurring frequency
> weekly Once a week; specify the day
- daily Every day
- disabled No scheduling
Syntax
set icon <name>
{
description <value> |
image <name> |
}
Options
<name> Name to identify the icon
+ description Icon description
+ image Icon image
Syntax
set shared local-user-database
{
user <name> |
{
disabled {no | yes} |
phash <value> |
password
}
user-group <name> {user <value>}
}
Options
> user User name
+ disabled Disabled (no or yes)
+ phash phash value
passwordPrompts to set password
> user-group User group name
> user User name or list of names enclosed in [ ]
Syntax
set shared log-settings
{
config |
{
any
{
send-email using-email-setting <value> |
send-snmptrap using-snmptrap-setting <value> |
send-syslog using-syslog-setting <value>
}
}
email <name> |
{
format |
{
config <value> |
hip-match <value> |
system <value> |
escaping {escape-character <value> | escaped-characters <value>}
}
server <name>
{
and-also-to <value> |
display-name <name> |
from <value> |
gateway <value> |
to <value>
}
}
hipmatch |
{
any
{
send-email using-email-setting <value> |
send-snmptrap using-snmptrap-setting <value> |
send-syslog using-syslog-setting <value>
}
mdm |
{
critical | high | informational | low | medium
{
send-email using-email-setting <value> |
send-syslog using-syslog-setting <value>
}
}}
snmptrap <name> |
{
version
{
v2c server <name> |
{
community <value> |
manager <value> |
}
v3 server <name>
{
authpwd <value> |
engineid <value> |
manager <value> |
privpwd <value> |
user <value>
}
}
}
syslog <name>
{
format |
{
config <value> |
hip-match <value> |
system <value> |
escaping {escape-character <value> | escaped-characters <value>}
}
server <name>
{
facility {LOG_LOCAL0 | LOG_LOCAL1 | LOG_LOCAL2 | LOG_LOCAL3 |
LOG_LOCAL4 | LOG_LOCAL5 | LOG_LOCAL6 | LOG_LOCAL7 | LOG_USER} |
format {BSD | IETF}
port <value> |
server <value> |
transport {SSL | TCP | UDP}
}
}
system {critical | high | informational | low | medium}
{
send-email using-email-setting <value> |
send-snmptrap using-snmptrap-setting <value> |
send-syslog using-syslog-setting <value>
}
}
Options
> config Configuration log settings (any)
> send-email Send email using email setting value
> send-snmptrap Send SNMP trap using SNMP trap setting value
> send-syslog Send syslog using syslog setting value
> email Email log settings name
> format Custom formats for forwarded logs
Syntax
set shared pdf-summary-report <name>
{
custom-widget <name> |
{
chart-type {bar | line | pie | table} |
column <value> |
row <value>
}
footer {note <value>} |
header {caption <value>}|
predefined-widget <name> |
{
chart-type {bar | line | pie | table} |
column <value> |
row <value>
}
}
Options
<name> PDF report to configure
> custom-widget Report widget layout information
+ chart-type Chart type (bar, line, pie, or table)
+ column Column number (1-3)
+ row Row number (1-6)
> footer Footer information for PDF summary layout
+ note Static string to be printed as a note
> header Header information for PDF summary layout
+ caption Caption for the layout
> predefined-widget Predefined report widget layout information
+ chart-type Chart type (bar, line, pie, or table)
+ column Column number (1-3)
+ row Row number (1-6)
Syntax
set shared report-group <name> |
{
title-page {no | yes} |
custom-widget <value> |
{
custom-report <value> |
log-view <value> |
pdf-summary-report <value>
predefined-report <value>
}
variable <name> {value <value>}
}
Options
<name> Report group to configure
+ title-page Include title page
> custom-widget Custom-widget value
> custom-report Custom report value
> log-view Log view value
> pdf-summary-report PDF summary report value
> predefined-report Predefined report value
> variable Variable name; option to include a value
Syntax
set shared reports <name>
{
caption <value> |
disabled {no | yes} |
end-time <value> |
frequency daily |
period {last-12-hrs | last-15-minutes | last-24-hrs | last-30-days | last60-seconds | last-7-calendar-days | last-7-days | last-calendar-day |
last-calendar-month | last-calendar-week | last-hour} |
query <value> |
start-time <value> |
topm <value> |
topn <value> |
type
{
hipmatch |
{
group-by {day-of-receive_time | hour-of-receive_time | machinename |
matchname | matchtype | quarter-hour-of-receive_time | src |
srcuser | vsys} |
last-match-by time_generated |
aggregate-by {day-of-receive_time | hour-of-receive_time |
machinename | matchname | matchtype | quarter-hour-ofreceive_time | src | srcuser | vsys | <value>} |
labels <value> |
values {repeatcnt | <value>}
}
hostinfo |
{
sortby {encryption-not-set | enrollment-time | has-malware | lastcheckin-time | last-unenroll-time | mac-address | managed | model
| os | os-version | passcode-not-set | rooted-or-jailbroken |
udid | user} |
aggregate-by {day-of-receive_time | hour-of-receive_time |
machinename | matchname | matchtype | quarter-hour-ofreceive_time | src | srcuser | vsys | <value>} |
labels <value> |
}
Options
<name> Report to configure
+ caption Caption value
+ disabled Disabled (no or yes)
Syntax
set shared server-profile
{
kerberos <name> |
{
admin-use-only {no | yes} |
domain <name> |
realm <name> |
server <name> {host <value> | port <value>}
}
ldap <name> |
{
admin-use-only {no | yes} |
base <value> |
bind-dn <value> |
bind-password <value> |
bind-timelimit <value> |
disabled {no | yes} |
domain <name> |
ldap-type {active-directory | e-directory | none | sun} |
retry-interval <value> |
ssl {no | yes} |
timelimit <value> |
server <name> {address <value> | port <value>}
}
netflow <name> |
{
active-timeout {value} |
export-enterprise-fields {no | yes} |
server <name> {host {<ip/netmask> | <value>} | port <value>} |
template-refresh-rate {minutes <value> | packets <value>}
}
radius <name>
{
admin-use-only {no | yes} |
checkgroup {no | yes} |
domain <name> |
retries <value> |
timeout <value> |
server <name> {ip-address <ip_address> | port <value> | secret <value>}
}
}
Options
> kerberos Kerberos profile name
Syntax
set shared tags <name> comment
Options
<name> Specifies tag to configure
+ comment Specify optional text comment
show
show
Displays information about the current candidate configuration.
Syntax
show <context>
Options
<context> Specifies a path through the hierarchy. For available contexts in the hierarchy, press <tab>.
Sample Output
The following command shows the full candidate hierarchy.
username@hostname# show
The following commands can be used to display the hierarchy segment for network interface.
Use the edit command to move to the level of the hierarchy, and then use the show command
without specifying context:
edit setting
[edit network interface] show
top
top
Changes context to the top hierarchy level.
Syntax
top
Options
None
Sample Output
The following command changes context from the network level of the hierarchy to the top level.
[edit network]
username@hostname# top
[edit]
username@hostname#
up
up
Changes context to the next higher hierarchy level.
Syntax
up
Options
None
Sample Output
The following command changes context from the setting level of the hierarchy to the network level.
[edit setting]
username@hostname# up
[edit network]
username@hostname#
up
ls on page 693
up
up
clear
clear
Resets information, counters, sessions, or statistics.
Syntax
clear
{
job <id> |
log {alarm | config | hipmatch | mdm | system} |
query {all-by-session | id <value> |
report {all-by-session | id <value> |
Options
> job Clears the download job with the specified ID
> log Clears the specified log (alarm, config, hipmatch, mdm, or system)
> query Clears counters
> all-by-session Clears all query jobs for this session
> id Clears the query job with the specified ID
> report Clears report jobs
> all-by-session Clears all report jobs for this session
> id Clears the report job with the specified ID
Sample Output
The following command clears the job with ID 223.
username@hostname> clear job id 233
Session 2245 cleared
username@hostname>
configure
configure
Enters Configuration mode.
Syntax
configure
Options
None
Sample Output
To enter Configuration mode from Operational mode, enter the following command.
username@hostname> configure
Entering configuration mode
[edit]
username@hostname#
debug authd
debug authd
Defines settings for authd service debug logging.
Syntax
debug authd {off | on | show}
Options
> off Turns off debug logging
> on Turns on authd service debug logging
> show Displays current debug logging setting
Sample Output
The following command turns the authd debugging option on.
admin@PA-HDF> debug authd on
admin@PA-HDF>
debug cli
debug cli
Defines settings and display information for debugging the CLI connection.
Syntax
debug cli
{
detail |
off |
on |
show
}
Options
> detail Shows details information about the CLI connection
> off Turns the debugging option off
> on Turns the debugging option on
> show Shows whether this command is on or off
Sample Output
The following command shows details of the CLI connection.
admin@PA-HDF> debug cli detail
Environment variables :
(USER . admin)
(LOGNAME . admin)
(HOME . /home/admin)
(PATH . /usr/local/bin:/bin:/usr/bin)
(MAIL . /var/mail/admin)
(SHELL . /bin/bash)
(SSH_CLIENT . 10.31.1.104 1109 22)
(SSH_CONNECTION . 10.31.1.104 1109 10.1.7.2 22)
(SSH_TTY . /dev/pts/0)
(TERM . vt100)
(LINES . 24)
(COLUMNS . 80)
(PAN_BASE_DIR . /opt/pancfg/mgmt)
PAN_BUILD_TYPE : DEVELOPMENT
Total Heap : 7.00 M
Used
: 5.51 M
Nursery
: 0.12 M
admin@PA-HDF>
debug cryptod
debug cryptod
Sets the debug options for the cryptod daemon.
Syntax
debug cryptod
{
global {off | on | show}
show counters
}
Options
> global Controls debug levels
> show Shows whether this command is on or off
> off Turns the debugging option off
> on Turns the debugging option on
> show Shows Cryptod debug counters
Sample Output
The following command displays the current cryptod debugging setting.
admin@PA-HDF> debug cryptod global show
sw.cryptod.runtime.debug.level: debug
admin@PA-HDF>
debug management-server
debug management-server
Configures settings for debugging the management server.
Syntax
debug management-server
clear |
client {disable <value> | enable <value>} |
config version <value> |
conn |
db-intervals db {dailythsum | dailytrsum | hourlythsum | hourlytrsum |
thsum | trsum | weeklythsum | weeklytrsum} |
{
end-time <value> |
period {last-12-hours | last-24-hrs | last-30-days | last-7-calendardays | last-7-days | last-calendar-day | last-calendar-month | lastcalendar-week | last-hour} |
start-time <value>
}
db-rollup {off | on} |
log-collector-agent-status |
log-forwarding-status |
memory {info | trim} |
off |
on {debug | dump | error | info | warn} |
rolledup-intervals db {dailythsum | dailytrsum | hourlythsum | hourlytrsum
| thsum | trsum | weeklythsum | weeklytrsum} |
{
end-time <value> |
period {last-12-hours | last-24-hrs | last-30-days | last-7-calendardays | last-7-days | last-calendar-day | last-calendar-month | lastcalendar-week | last-hour} |
start-time <value>
}
set {all | <name> {all | basic | detail}
show |
template dump-config{
xpath <value> |
from {local | merged | template}
}
unset {all | <name> {all | basic | detail}
user info name <value>
Options
> clear Clears all debug logs
> client Enables or disables management server client processes (specify process type)
> conn Prints management server connection entries
> db-intervals Displays available summary intervals for a given period
+ end-time End Time, e.g. 2008/12/31 11:59:59
debug management-server
debug management-server
Sample Output
The following example turns management server debugging on.
admin@PA-HDF> debug management-server on
(null)
admin@PA-HDF>
The following example enables the management server network processor agent.
admin@PA-HDF> debug management-server client enable npagent
admin@PA-HDF>
The following example displays all of the available hourly summary intervals for the trsum database.
username@hostname> debug management-server db-intervals period last-calendarday db hourlytrsum
hourlytrsum periods from 2011/06/15 00:00:00 to 2011/06/15 23:59:59
hourlytrsum 2011/06/15 00:00:00 to 2011/06/15 11:59:59
hourlytrsum 2011/06/15 13:00:00 to 2011/06/15 23:59:59
The following example displays the breakdown of the trsum report into summary-based partial reports.
username@hostname> debug management-server rolledup-intervals period last-7days db trsum
Rolled up periods from 2011/02/17 14:03:38 to 2011/02/24 14:03:37
trsum 2011/02/17 14:03:38 to 2011/02/19 23:59:59
dailytrsum 2011/02/20 00:00:00 to 2011/02/23 23:59:59
hourlytrsum 2011/02/24 00:00:00 to 2011/02/24 13:59:59
debug master-service
debug master-service
Configures settings for debugging the master service.
Syntax
debug master-service
{
internal-dump |
off |
on {debug | dump | error | info | warn} |
show
}
Options
> internal-dump Dumps internal state of service to its log
> off Turns off debug logging
> on Turns on masterd service debug logging
debug Only output error, warning, info and debug logs
dump Output all logs
error Only output error logs
info Only output error, warning and info logs
warn Only output error and warning logs
> show Displays current debug logging setting
Sample Output
The following command dumps the internal state of the master server to the log.
admin@PA-HDF> debug master-service internal-dump
admin@PA-HDF>
debug mdmd
debug mdmd
Configures settings for debugging Mobile Security Manager devices.
Syntax
debug mdmd
{
clear
{domain-map |
group {all | <value>} |
log |
pending-actions filter <value>
} |
db {count <value> | find <value>} |
encrypt-configure-profile {no | yes} |
get |
ignore-client-cert {no | yes}|
off |
on <level> |
refresh directory-integration {all | <value> |
reset {cloud-connection | directory-integration | gateway-connection |
stats} |
set
agent {all | basic | detail} |
all |
base {all | config | id} |
comm {all | basic | detail} |
db {all | basic | detail} |
hip {all | basic | detail} |
ldap {all | basic | detail} |
mdm {all | apns | app | basic | cloud | detail | device | gsm,user |
warn} |
misc {all | misc}
}
show {cloud-stats | gateway-connection | log-stats | memory | setting |
stats | thread-state} |
unset |
use-cloud-notifications |
}
Sample Output
The following command configures debugging settings to ignore verification of the client certificate.
admin@PA-HDF> debug mdmd ignore-client-cert yes
admin@PA-HDF>
debug mdmd
Options
> clear Clear data
> domain-map Clear the domain map
> group Clear group data (specify value or all)
> log Clear debug logs
> pending-actions Clear pending actions for devices (can specify device filter)
> db Run command vs database
> count Count HIP database (specify number)
> find Find in HIP database (specify value to match)
> encrypt-configure-profile Specify whether to encrypt iOS configuration profile (yes or no)
> get Display current debug logging setting
> ignore-client-cert Specify whether to ignore the verification of client cert
> off Turn off debug logging
> on Turn on debug logging (specify level: debug, dump, error, info, or warn)
> refresh Refresh data
> directory-integration (specify all of value)
> reset Reset data
> cloud-connection Reset cloud connection
> directory-integration Reset group mapping data (specify all or value)
> gateway-connection Reset gateway connection
> stats Reset mdm statistics
> set Turn on component debug logging
> agent (specify all, basic, or detail)
> all
> base (specify all, config, or id)
> comm (specify all, basic, or detail)
> db (specify all, basic, or detail)
> hip (specify all, basic, or detail)
> ldap (specify all, basic, or detail)
> mdm (specify all, apns, app, basic, cloud, detail, device, gsm,user, or warn)
> misc (specify all or misc)
> show Show debug data
> cloud-stats Show cloud connection statistics
> gateway-connection Show GlobalProtect Gateway Connections (specify detail or summary)
> log-stats Show log statistics
> memory Show memory usage (specify detail or summary)
> setting Show debug setting
> stats Show mdm process statistics (can specify all)
> thread-state Show daemon threads
> unset Turn off component debug logging
> use-cloud-notifications Specify whether to use or turn off cloud notifications for testing purposes
debug software
debug software
Configures software processes debugging features.
Syntax
debug software
{
core { management-server | mdmd | web-server} |
fd-limit {limit <value> | service <value>} |
no-fd-limit service <value> |
no-virt-limit service <value> |t
restart {appdb | hipdb | management-server | mdmd | web-server} |
trace {management-server | mdmd | web-server} |
virt-limit {limit <value> | service <value>}
}
Options
> core Debugs process core
> management-server Management server process
> mdmd Mobile Security Manager process
> web-server Web server process
> fd-limit Sets open fd limit (0-4294967295) and service value
> no-fd-limit Disables open fd limit service
> no-virt-limit Disables maximum virtual memory limit service
> restart Restarts processes
> appdb App database process
> hipdb HIP database process
> management-server Management server process
> mdmd Mobile Security Manager process
> web-server Web server process
> trace Gets process backtraces
> management-server Management server process
> mdmd Mobile Security Manager process
> web-server Web server process
> virt-limit Sets maximum virtual memory limit (0-4294967295) and service value
Sample Output
The following command restarts the web server.
admin@PA-HDF> debug software restart web-server
admin@PA-HDF>
debug swm
debug swm
Configures settings for debugging the Palo Alto Networks software manager.
Syntax
debug swm
{
history |
info {image <image_name>} |
install {image <image_name> | patch <value>} |
list |
load {image <image_name>} |
log |
rebuild-content-db |
refresh content |
revert |
status |
unlock
}
Options
> history Shows history of software install operations
> info Displays info on current or specified image
> install Installs specified image and optional patch
> list Lists software versions available for install
> loadLoads specified image
> log Shows log of PAN Software Manager
> rebuild-content-dbRebuilds content database
> refresh Reverts back to last successfully installed content
> revert Reverts back to last successfully installed software
> status Shows status of PAN Software Manager
> unlock Unlocks PAN Software Manager
Sample Output
The following command shows the list of available software versions.
admin@PA-HDF> debug swm list
3.1.0-c4.dev
3.1.0-c1.dev_base
3.0.0-c207
3.0.0-c206
admin@PA-HDF>
debug system
debug system
Defines settings for system debugging actions.
Syntax
debug system
{
check-fragment |
disk-smart-info disk-1 |
disk-sync |
maintenance-mode |
route-table {ethernet1 | management}
}
Options
> check-fragment Checks disk fragmentation
> disk-smart-info Get disk drive SMART information
> disk-sync Flushes all writes out to disk
> maintenance-mode Reboots the system to maintenance mode
> route-tableShow ip route table (specify ethernet1 or management}
Sample Output
The following command reboots the system to maintenance mode.
admin@PA-HDF> debug system maintenance-mode
admin@PA-HDF>
debug tac-login
debug tac-login
Configures settings for debugging the Palo Alto Networks Technical Assistance Center (TAC)
connection.
Syntax
debug tac-login {challenge | permanently-disable | response}
Options
> challenge Gets challenge value for TAC login
> permanently-disable Permanently turns off TAC login debugging
> response Runs verification of challenge response for TAC login
Sample Output
The following command runs the verification of the response value for TAC debugging.
admin@PA-HDF> debug tac-login response
Defaulting to root passwd login in debug mode
Password:
admin@PA-HDF>
debug user
debug user
Configures settings for debugging user accounts.
Syntax
debug user
{
clear {domain-map | group {all | <value>} | log} |
dump {domain-map | id {all | id <value> | name <value>} | state} |
refresh group-mapping {all | id <value> |
refresh group-mapping {all | id <value>
}
Options
> clear Clear data.
> domain-map Clear domain map
> group Clear group data (all or value)
> log Clear debug logs
> dump Dump debug data
> domain-map Dump domain map
> id Dump id data
> all Display all name and id
> id
> name
> state
> refresh Refresh data (group-mapping all or value)
> reset Reset data (group-mapping all or value)
Sample Output
The following command clears all user group information for debugging.
username@hostname> debug user clear group all
username@hostname>
delete
delete
Removes specified types of files from disk or restore the default comfort pages that are presented when
files or URLs are blocked.
Syntax
delete
{
admin-sessions |
config |
saved <file_name>
config-audit-history |
content |
{
cache |
{
curr-content type {aho-regex | all | decoder | dfa | sml | tdb}
version <value> |
old-content
}
update <file_name>
}
core {management-plane file <file_name>} |
license key <value> |
logo |
pcap directory <directory_name> |
radius-user {admin-name <name>} |
report |
{
custom scope <name> report-name <name> file-name <name> |
predefined scope <name> report-name <name> file-name <name> |
summary scope <name> report-name <name> file-name <name>
}
software {image <file_name> | version <value>} |
ssh-authentication-public-key |
sslmgr-store |
{
certificate-info {portal} |
{
db-serialno <value> |
name <value> |
serialno <value>
}
satellite-info {portal} |
{
name <value> |
serialno <value> |
state {assigned | unassigned}
}
satellite-info-revoke-certificate portal <value> {serialno <value>}
}
user-file ssh-known-hosts |
delete
Options
> admin-sessions Removes all active administrative sessions
> config Removes configuration files on disk
> repo Config repository
* device Device name
> file Named snapshot
> running-config Versioned running configuration
> saved Filename
> config-audit-history Removes the configuration audit history
> content Removes content images or cache on disk
> cache Removes cache files based
> curr-content Removes cache files based on Engine version and type
* type Type of content to be deleted
aho-regex Aho-regex cache
all All caches
decoder Decoder cache
dfa DFA cache
sml SML cache
tdb TDB cache
* version Content version to delete
> old-content Remove ALL old content
> update Filename to remove
> core Removes core management or data plane cores on disk
> license Removes a license key file
> logo Removes a custom logo file
> pcap Removes packet capture files
> radius-user Removes a RADIUS users local account
> report Removes specified reports (custom, predefined, or summary)
> software Removes a software image
> ssh-authentication-public-key Deletes SSH authentication public key
> sslmgr-store Deletes the specified SSL manager dynamic configuration
> user-group-cache Deletes user group cache files in disk
Sample Output
The following command deletes the saved configuration file named running-config.xml.bak.
username@hostname> delete config saved running-config.xml.bak
username@hostname>
exit
exit
Exits the PAN-OS CLI.
Note: The exit command is the same as the quit command.
Syntax
exit
Options
None
find
find
Lists CLI commands containing the specified keyword.
Syntax
find command keyword <value>
Options
<value> Specifies a keyword.
Sample Output
The following command lists all CLI commands containing the keyword mdm.
username@hostname# find command keyword mdm
debug mdmd on <error|warn|info|debug|dump>
debug mdmd encrypt-configure-profile <yes|no>
debug mdmd ignore-client-cert <yes|no>
debug mdmd use-cloud-notifications <yes|no>
debug mdmd set agent <basic|detail|all>
debug mdmd set base <config|id|all>
...
username@hostname#
grep
grep
Finds and lists lines from log files that match a specified pattern.
Syntax
grep pattern <value>
{
after-context <number> |
before-context <number> |
context <number> |
count |
ignore-case {no | yes} |
invert-match {no | yes} |
line-number {no | yes} |
max-count <number> |
no-filename {no | yes} |
dp-log <file_name> |
mp-log <file_name>
}
Options
+ after-context Prints the matching lines plus the specified number of lines that follow the matching lines
+ before-context Prints the matching lines plus the specified number of lines that precede the matching lines
+ context Prints the specified number of lines in the file for output context
+ count Specifies whether a count is included in the results
+ ignore-case Ignores case distinctions
+ invert-match Selects non-matching lines instead of matching lines
+ line-number Adds the line number at the beginning of each line of output
+ max-count Stops reading a file after the specified number of matching lines
+ no-filename Does not add the filename prefix for output
* pattern Indicates the string to be matched
> dp-log Indicates the data plane log file to search for the pattern (press <tab> for a list of file names)
> mp-log Indicates the management plane log file to search for the pattern (press <tab> for a list of file names)
Sample Output
The following command searches the brdagent.log file for occurrences of the string HEARTBEAT.
username@hostname> grep dp-log sysdagent.log
*
Jan 20 14:35:48 HEARTBEAT: Heartbeat failure
Jan 20 14:35:53 HEARTBEAT: Heartbeat failure
Jan 20 14:35:54 HEARTBEAT: Heartbeat failure
Jan 20 14:35:55 HEARTBEAT: Heartbeat failure
username@hostname>
pattern HEARTBEAT
on
on
on
on
core
core
core
core
4
1
8
2
less
less
Lists the contents of the specified log file.
Note: The dp-log option will not be available on devices that do not have a dataplane, such as the PA200.
Syntax
less
{
dp-log <filename> |
mp-backtrace <filename> |
mp-log <filename> |
webserver-log <filename>
}
Options
> dp-log Lists contents of the specified data plane log file (press <tab> for a list of log files)
> mp-backtrace Lists contents of the specified management plane backtrace file (press <tab> for a list of log
files)
> mp-log Lists contents of the specified management plane log file (press <tab> for a list of log files)
> webserver-log Lists contents of the specified webserver log file (press <tab> for a list of log files)
Sample Output
The following command lists the contents of the web server error log.
username@hostname>
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
default:2 main
...
ls
ls
Displays debug file listings.
Syntax
ls
{
long-format {no | yes} |
reverse-order {no | yes} |
sort-by-time {no | yes} |
content {apps | cache | decoders | global | pan_appversion | scripts |
threats} |
database <value> |
global <filename> |
mp-backtrace <filename> |
mp-global <filename> |
mp-log <filename> |
webserver-log <filename>
}
Options
+ long-format File listing format (use long format)
+ reverse-order File listing order (list in reverse order)
+ sort-by-time Sort file listing by time
> content Specify content to display
> database Database listing
> global Global files (select file from the list provided; press <tab> for list)
> mp-backtrace MP backtrace file (select file from the list provided; press <tab> for list)
> mp-global MP global files (select file from the list provided; press <tab> for list)
> mp-log MP logs (select file from the list provided; press <tab> for list)
> webserver-log Web server logs (select file from the list provided; press <tab> for list)
netstat
netstat
Displays network connections and statistics.
Syntax
netstat
{
all {no | yes} |
cache {no | yes} |
continuous {no | yes} |
extend {no | yes} |
fib {no | yes} |
groups {no | yes} |
interfaces {no | yes} |
listening {no | yes} |
numeric {no | yes} |
numeric-hosts {no | yes} |
numeric-ports
numeric-users {no | yes} |
programs {no | yes} |
route {no | yes} |
statistics {no | yes} |
symbolic {no | yes} |
timers {no | yes} |
verbose {no | yes}
}
Options
+ all Display all sockets (default = connected)
+ cache Display routing cache instead of Forwarding Information Base (FIB)
+ continuous Continuous listing
+ extend Display other/more information
+ fib Display FIB (default)
+ groups Display multicast group memberships
+ interfaces Display interface table
+ listening Display listening server sockets
+ numeric Do not resolve names
+ numeric-hosts Do not resolve host names
+ numeric-ports Do not resolve port names
+ numeric-users Do not resolve user names
+ programs Display PID/Program name for sockets
+ route Display routing table
+ statistics Display networking statistics (like SNMP)
+ symbolic Resolve hardware names
+ timers Display timers
+ verbose Display full details
netstat
Sample Output
The following command shows an excerpt from the output of the netstat command.
username@hostname> netstat all yes
...
Active UNIX domain sockets (servers and established)
Proto RefCnt Flags
Type
State
I-Node Path
unix 2
[ ACC ]
STREAM
LISTENING
5366
/tmp/ssh-lClRtS1936/
agent.1936
unix 2
[ ]
DGRAM
959
@/org/kernel/udev/udevd
unix 18
[ ]
DGRAM
4465
/dev/log
...
ping
ping
Checks network connectivity to a host.
Syntax
ping host <value>
{
bypass-routing {no | yes} |
count <value> |
do-not-fragment {no | yes} |
inet6 {no | yes} |
interval <value> |
no-resolve {no | yes} |
pattern <value> |
size <value> |
source <value> |
tos <value> |
ttl <value> |
verbose {no | yes}
}
Options
> bypass-routing Sends the ping request directly to the host on a direct attached network, bypassing usual
routing table
> count Specifies the number of ping requests to be sent (1-2,000,000,000)
> do-not-fragment Prevents packet fragmentation by use of the do-not-fragment bit in the packets IP header
> inet6 Specifies that the ping packets will use IP version 6
> interval Specifies how often the ping packets are sent (0 to 2000000000 seconds)
> no-resolve Provides IP address only without resolving to hostnames
> pattern Specifies a custom string to include in the ping request (you can specify up to 12 padding bytes to fill
out the packet that is sent as an aid in diagnosing data-dependent problems)
> size Specifies the size of the ping packets (0-65468 bytes)
> source Specifies the source IP address for the ping command
> tos Specifies the type of service (TOS) treatment for the packets by way of the TOS bit for the IP header in the
ping packet (1-255)
> ttl Specifies the time-to-live (TTL) value for the ping packet (IPv6 hop-limit value) (0-255 hops)
> verbose Requests complete details of the ping request.
* host Specifies the host name or IP address of the remote host
ping
Sample Output
The following command checks network connectivity to the host 66.102.7.104, specifying 4 ping
packets and complete details of the transmission.
username@hostname> ping count 4 verbose yes host 66.102.7.104
PING 66.102.7.104 (66.102.7.104) 56(84) bytes of data.
64 bytes from 66.102.7.104: icmp_seq=0 ttl=243 time=316 ms
64 bytes from 66.102.7.104: icmp_seq=1 ttl=243 time=476 ms
64 bytes from 66.102.7.104: icmp_seq=2 ttl=243 time=376 ms
64 bytes from 66.102.7.104: icmp_seq=3 ttl=243 time=201 ms
--- 66.102.7.104 ping statistics --4 packets transmitted, 4 received, 0% packet loss, time 3023ms
rtt min/avg/max/mdev = 201.718/342.816/476.595/99.521 ms, pipe 2
username@hostname>
quit
quit
Exits the current session for the firewall.
Note: The quit command is the same as the exit command.
Syntax
quit
Options
None
request certificate
request certificate
Generate a self-signed security certificate.
Syntax
request certificate
{
generate certificate-name <value> name <value> |
{
ca {no | yes} |
country-code <value> |
days-till-expiry <value> |
digest <value> |
email <value> |
filename <value> |
locality <value> |
nbits <value> |
ocsp-responder-url <value> |
organization <value> |
signed-by <value> |
state <value> |
certificate-name <value> |
name <ip> |
alt-email <value> |
hostname <value> |
ip <ip/netmask> |
organization-unit <value>
}
renew certificate-name <value> {days-till-expiry <value>} |
}
Options
> generate Generate certificate
+ ca Make this a signing certificate
+ country-code Two-character code for the country in which the certificate will be used
+ days-till-expiry Number of days until expiry (1-7300)
+ digest Digest Algorithm (md5, sh1, sha256, sha384, sha512)
+ email Email address of the contact person
+ filename File name for the certificate
+ locality Locality (city, campus, or other local area)
+ nbits Length of the key (number of bits in the certificate 1024, 15360, 2048, 3072, 512)
+ organization Organization using the certificate
+ signed-by CA for the signing certificate
+ state Two-character code for the state or province in which the certificate will be used
* certificate-name Name of the certificate object
* name IP address or fully qualified domain name (FQDN) to appear on the certificate
> alt-email Subject alternate email type (value or list of values enclosed in [ ])
> hostname Subject alternate name DNS type (value or list of values enclosed in [ ])
> ip Subject alternate name IP type (IP address and network mask; value or list of values enclosed in [ ])
> organization-unit Department using the certificate (value or list of values enclosed in [ ])
request certificate
Sample Output
The following command renews the certificate mycert.
username@hostname> request certificate renew certificate-name mycert
username@hostname>
request commit-lock
request commit-lock
Sets options for locking commits.
Syntax
request commit-lock
{
add {comment <value>} |
remove {admin <value>}
}
Options
> add Prevents other users from committing
+ comment Comment value
> remove Releases commit lock previously held
+ admin Administrator holding the lock
request config-lock
request config-lock
Sets options for locking configurations.
Syntax
request config-lock {add {comment <value>} | remove}
Options
> add Prevents other users from changing the configuration
> remove Releases a previously held configuration lock
request content
request content
Perform application level upgrade operations.
Syntax
request content
{
downgrade install {<value> |
upgrade
{
check |
download latest {sync-to-peer {no | yes}} |
info |
install
{
commit {no | yes} |
sync-to-peer {no | yes} |
file <filename> |
version latest
}
}
}
Options
> downgrade Installs a previous content version
> upgrade Performs content upgrade functions
> check Obtains information on available packages from the Palo Alto Networks server
> download Downloads content packages
+ sync-to-peer Sends a copy to HA peer
> info Shows information about available content packages
> install Installs content packages
+ commit Indicates whether the installed package will be committed to the firewall
+ sync-to-peer Indicates whether a copy of the package will be provided to another high-availability
peer firewall
> file Specifies the name of the file containing the content package
> version Specifies the latest version of the content software package
Sample Output
The following command lists information about the firewall server software.
username@hostname> request content upgrade check
Version
Size
Released on Downloaded
------------------------------------------------------------------------13-25
10MB 2007/04/19 15:25:02
yes
username@hostname>
request content
request device-registration
request device-registration
Performs device registration.
Syntax
request device-registration password <pwd> username <user>
Options
* password Specifies the support portal password for device access
* username Specifies the support portal user name for device access
Sample Output
The following command registers the device with the specified user name and password.
username@hostname> request device-registration username admin password
adminpwd
username@hostname>
request generate-report
request generate-report
Requests a report. Use the show report command to obtain reports that have been generated using this
command.
Syntax
request generate-report type <type>
Options
all
compliance
least-installed-android-apps
least-installed-ios-apps
managed-devices
most-installed-android-apps
most-installed-ios-apps
os-count
top--android-models
top-hardware-models
top-ios-models
top-malware
Sample Output
The following command generates the OS count report.
username@hostname> request generate-report type os-count
Report was successfully generated
username@hostname>
request global-protect-gateway
request global-protect-gateway
Requests performance of GlobalProtect gateway functions.
Syntax
request global-protect-gateway
{
client-logout gateway <value> reason force-logout user <value> |
{
computer <value> |
domain <value>
}
satellite-logout gateway <value> reason force-logout serialno <value> |
unlock auth-profile <value> user <value> vsys <value> {is-seq {no | yes}}
}
Options
> client-logout GlobalProtect gateway user logout
+ computer User's computer name
+ domain User's domain name
* gateway Name of the GlobalProtect gateway remote user tunnel name
* reason Reason for logout (force)
* user User name
> satellite-logout GlobalProtect gateway satellite logout
* gateway Name of the GlobalProtect gateway site-to-site tunnel name
* reason Reason for logout (force)
* serialno Device serial number
> unlock Unlock locked users
+ is-seq Is this authentication sequence?
* auth-profile Auth Profile
* user User name
* vsys Virtual System
request license
request license
Performs license-related operations.
Syntax
request license {fetch <auth-code> | info | install}
Options
> fetch Gets a new license key using an authentication code
+ auth-code Specifies the authentication code to use in fetching the license
> info Displays information about currently owned licenses
> install Installs a license key
Sample Output
The following command requests a new license key with the authentication code 123456.
request master-key
request master-key
Changes the master key.
Syntax
request master-key lifetime <value> new-master-key <value>
{
current-master-key <value> |
reminder <value> |
}
Options
+ current-master-key Specifies the current master key (64-bit encoded public key)
+ reminder When to send expiry reminder, in hours (1-8760)
* lifetime Lifetime of the new key, in hours (1-17520)
* new-master-key Specifies a new master key (64-bit encoded public key)
request password-change-history
request password-change-history
Displays the history of the user password and re-encrypts it.
Syntax
request password-change-history
{
dump-history {master-key <value>} |
re-encrypt old-master-key <value> {master-key <value>}
}
Options
> dump-history Dumps contents of password history
+ master-key Master key used to encrypt passwords
> re-encrypt Re-encrypts password
+ master-key Masterkey to encrypt historical passwords
* old-master-key Old masterkey used to encrypt historical passwords
request password-hash
request password-hash
Generates a hashed string for the user password.
Syntax
request password-hash password <pwd>
Options
* usernameSpecifies the plain text user name for the password that requires the hash string
* password Specifies the plain text password that requires the hash string
Sample Output
The following command generates a hash of the specified password.
username@hostname> request password-hash password mypassword
$1$flhvdype$qupuRAx4SWWuZcjhxn0ED.
request quota-enforcement
request quota-enforcement
Enforces disk quotas for logs and packet captures.
Syntax
request quota-enforcement
Options
None
Sample Output
The following command enforces the disk quotas.
username@hostname> request quota-enforcement
request restart
request restart
Restarts the system or software modules.
CAUTION: Using this command causes the firewall to reboot, resulting in the
temporary disruption of network traffic. Unsaved or uncommitted changes will be
lost.
Syntax
request restart {system}
Options
> system Reboots the system
Sample Output
The following command restarts all the firewall software.
username@hostname> request restart system
request shutdown
request shutdown
Performs a clean shutdown of the system.
CAUTION: Using this command causes the firewall to shut down, and network
traffic will be disrupted. In addition, unsaved or uncommitted changes will be lost.
Syntax
request shutdown system
Options
None
Sample Output
The following command shuts down the firewall.
username@hostname> request shutdown system
request stats
request stats
Generates a dump of the statistics.
Syntax
request stats dump
Options
None
Sample Output
The following command orders a statistics dump.
username@hostname> request stats dump
Exec job enqueued with jobid 56
56
username@hostname>
request support
request support
Obtains technical support information.
Syntax
request support {check | info}
Options
> check Gets support information from the Palo Alto Networks update server
> info Shows downloaded support information
Sample Output
The following command shows downloaded support information.
username@hostname> request support info
0
Support Home
https://support.paloaltonetworks.com
Manage Cases
https://support.paloaltonetworks.com/pa-portal/
index.php?option=com_pan&task=vie
wcases&Itemid=100
Download User Identification Agent
https://support.paloaltonetworks.com/pa-portal/
index.php?option=com_pan&task=sw_
updates&Itemid=135
866-898-9087
[email protected]
November 07, 2009
Standard
10 x 5 phone support; repair and replace hardware service
username@hostname>
request system
request system
Performs system functions, including self testing, downloading system software, and requesting
information about the available software packages.
Syntax
request system
{
private-data-reset |
raid
{
add <drive> {force {no-format}} |
remove <drive> |
}
self-test |
{
crypto |
force-crypto-failure {dp <value> | mp <value>} |
software-integrity
}
self-test-job {crypto | software-integrity} |
software
{
check |
download {sync-to-peer {no | yes} | file <file> | version <version>} |
info |
install {load-config <value> | file <file> | version <version>}
}
}
Options
> private-data-reset Removes all of the logs and resets the configuration but does not reset content and software
versions
> raid Perform RAID operations (add or remove a drive)
> self-test This option is available in Common Criteria (CC) mode and Federal Information Processing Standard
140-2 (FIPS 140-2) mode (for more information, refer to Chapter 6, Maintenance Mode)
> crypto Performs a self-test on all of the cryptographic algorithms the system has on it; if a failure occurs,
the system will go into maintenance mode
> force-crypto-failure Causes the system to reboot and fail the specified cryptographic self-test when it
reboots; if a failure occurs, the system will go into maintenance mode
> dp Fail test on data plane
> mp Fail test on management plane
> software-integrity Performs a software integrity test; if a failure occurs, the system will go into
maintenance mode
> self-test-job Runs FIPS/CC self-test jobs
> crypto Runs crypto self-test job
> software-integrity Runs software integrity self-test job
> software Performs system software installation functions
> check Gets information from Palo Alto Networks server
> download Downloads software packages
request system
Sample Output
The following command requests information about the software packages that are available for
download.
username@hostname> request system software info
Version
Filename
Size
Released Downloaded
------------------------------------------------------------------------3.0.1
panos.4050-3.0.1.tar.gz
127MB 2010/02/07 00:00:00
no
3.1.0
panos.4050-3.1.0.tar.gz
127MB 2009/02/07 00:00:00
no
username@hostname>
request tech-support
request tech-support
Obtains information to assist technical support in troubleshooting.
Syntax
request technical support dump
Options
None
Sample Output
The following command creates a dump for technical support.
username@hostname> request tech-support dump
Exec job enqueued with jobid 1
1
username@hostname>
scp export
scp export
Uses SCP (secure copy) to upload files from the device to another system. Use this command to copy
files between the firewall and another host.
Syntax
scp export <option> to <target> {remote-port <port_number> | source-ip
<ip_address>}
{
certificate {certificate-name <value> | format <value> | include-key
<value> to <value>}|
configuration from <file_name> |
core-file {data-plane | management-plane} from <file_name> |
device-state |
log-file {data-plane | management-plane} |
logdb |
pdf-reports from <file_name> |
tech-support |
web-interface-certificate
}
Options
+ remote-port SSH port number on remote host (1-65535)
+ source-ip Set source address to specified interface address (x.x.x.x or IPv6)
* to Destination (username@host:path)
> certificate Use scp to export a certificate
> configuration Use scp to export a configuration file
* from File name
> core-file Use scp to export a core file
> data-plane Use scp to export a data plane core file
* from File name
> management-plane Use scp to export a management plane core file
* from File name
> device-state Use scp to export device state files from a GlobalProtect Portal
> log-file Use scp to export log file
> data-plane Use scp to export data-plane core-file
> management-plane Use scp to export management-plane core-file
> logdb Use scp to export a log database
> pdf-reports Use scp to export PDF reports
* from File name
> web-interface-certificate Use scp to export a web interface certificate
scp import
scp import
Uses SCP (secure copy) to download files to the device. Use this command to download a customizable
HTML replacement message (comfort page) in place of a malware infected file.
Syntax
scp import <option> from <source> {remote-port <port_number> | source-ip
<ip_address>}
{
certificate |
configuration |
content |
device-state |
keypair certificate-name <name> format {pem | pkcs12} passphrase <value> |
license |
logdb |
mobile-device-tags |
private-key certificate-name <name> format {pem | pkcs12} passphrase
<value> |
provisioning-profile |
software |
web-clip-icon {description}
}
Options
+ remote-port SSH port number on remote host (1-65535)
+ source-ip Set source address to specified interface address (x.x.x.x or IPv6)
* from Source (username@host:path)
> certificate Use scp to import an X.509 certificate
> configuration Use scp to import a configuration file
> content Use scp to import database content
> device-state Use scp to import device state files for a GlobalProtect Portal
> keypair Use scp to import an X.509 key pair
* certificate-name Name of the certificate object
* format Format of the keypair (PEM or PKCS12)
* passphrase Passphrase value
> license Use scp to import a license file
> logdb Use scp to import a log database
> mobile-device-tags Use scp to import mobile device tags
> private-key Use scp to import an X.509 key
* certificate-name Name of the certificate object
* format Format of the keypair (PEM or PKCS12)
* passphrase Passphrase for private key
> provisioning-profile Use scp to import a provisioning profile
> software Use scp to import a software package
> web-clip-icon Use scp to import web clip icons
Sample Output
The following command imports a license file from a file in user1s account on the machine with IP
address 10.0.3.4.
scp import
set cli
set cli
Configures scripting and pager options for the PAN-OS CLI. Options are included to display
configuration commands in default format, XML format, or as operational set commands.
Syntax
set cli
{
config-output-format {default | json | set | xml} |
confirmation-prompt {off | on} |
hide-ip |
hide-user |
op-command-xml-output {off | on} |
pager {off | on} |
scripting-mode {off | on} |
terminal {height <value> | type <value> | width <value>} |
timeout idle {never | value>}
}
Options
> config-output-format Sets the output format for the configuration file to the default, JSON, XML format, or
set command format
> configuration-prompt Enables or disables presentation of a confirmation prompt for some configuration
commands
> hide-ip Hides the last octet of the IP address in logs
> hide-user Hides user names in logs
> op-command-xml-outputDisplay xml response in operational commands
> pager Enables or disables pagers
> scripting-mode Toggles scripting mode (scripting mode will modify the CLI output such that special
characters used for formatting are suppressed)
> terminal Sets terminal parameters for CLI access
> height Sets terminal height (1-500)
> type Sets terminal type (press <tab> for list)
> width Sets terminal width (1-500)
> timeout Sets administrative session timeout values
+ idle Idle timeout (never or 0-1440 minutes; default = 60 minutes)
Sample Output
The following command sequence sets the configuration mode to use set command format for output
and then displays the output of the show system log-export-schedule command in Configuration
mode.
username@hostname> set cli config-output-format set
username@hostname> configure
Entering configuration mode
[edit]
username@hostname# edit deviceconfig
[edit deviceconfig]
username@hostname# show system log-export-schedule
set cli
set
set
set
set
deviceconfig system
deviceconfig system
deviceconfig system
deviceconfig system
10.16.0.97
set deviceconfig system
set deviceconfig system
mode yes
set deviceconfig system
admin
set deviceconfig system
mZDB7rbW5y8=
username@hostname#
log-export-schedule
log-export-schedule
log-export-schedule
log-export-schedule
10.16.0.97
10.16.0.97
10.16.0.97
10.16.0.97
description 10.16.0.97
enable yes
start-time 03:00
protocol ftp hostname
The following command sequence shows the same example after XML is specified as the command
output format.
username@hostname> set cli config-output-format xml
username@hostname> configure
Entering configuration mode
[edit]
username@hostname# edit deviceconfig
[edit deviceconfig]
username@hostname# show system log-export-schedule
<log-export-schedule>
<entry name="10.16.0.97">
<description>10.16.0.97</description>
<enable>yes</enable>
<start-time>03:00</start-time>
<protocol>
<ftp>
<hostname>10.16.0.97</hostname>
<port>21</port>
<passive-mode>yes</passive-mode>
<username>admin</username>
<password>mZDB7rbW5y8=</password>
</ftp>
</protocol>
</entry>
</log-export-schedule>
[edit deviceconfig]
[edit deviceconfig]
username@hostname#
set clock
set clock
Configures the system date and time.
Syntax
set clock {date <value> | time <value>}
Options
+ date Specify the date in yyyy/mm/dd format
+ time Specify the time in hh:mm:ss format (hh: 0-23, mm: 0-59, ss: 0-59)
Sample Output
The following command sets the system date and time.
username@hostname> set clock date 2009/03/20 time 14:32:00
username@hostname>
set data-access-password
set data-access-password
Configures the access password for the data filtering logs. The data filtering log records information on
the security policies that help prevent sensitive information such as credit card or social security
numbers from leaving the area protected by the firewall.
Syntax
set data-access-password <pwd>
Options
<pwd> Specifies the password for accessing data filtering logs
Sample Output
The following command sets the password for data filtering logs.
username@hostname> set data-access password 12345678
username@hostname>
set management-server
set management-server
Configures parameters for the management server, which manages configuration, reports, and
authentication for the firewall.
Syntax
set management-server
{
logging {import-end | import-start | off | on} |
unlock admin <user_name>
}
Options
> logging Sets the following logging options:
import-end Exit import mode
import-start Enter import mode
off Disable logging
on Allow logging
> unlock Unlocks locked administrators (specify username of administrator to unlock)
Sample Output
The following command enables logging on the management server.
username@hostname> set management-server logging on
username@hostname>
set password
set password
Configures the firewall password. When you issue this command, the system prompts you to enter the
old and new password and to confirm the new password.
Syntax
set password
Options
None
Sample Output
The following example shows how to reset the firewall password.
username@hostname>
Enter old password
Enter new password
Confirm password
set password
: (enter the old password)
: (enter the new password0
: (reenter the new password)
Password changed
username@hostname>
set ssh-authentication
set ssh-authentication
Configures a public key for Secure Shell (SSH) authentication.
Syntax
set ssh-authentication {public-key <value>}
Options
+ public-key Specifies the public key (RSA or DSA)
Sample Output
The following command configures the public key for SSH authentication.
username@hostname> set ssh-authentication public-key ssh-rsa AAAAB3N....
username@hostname>
set system
set system
Configures system logging parameters.
Syntax
set system
{
logging |
{
default |
default-policy-logging <value> |
log-suppression {no | yes} |
max-log-rate <value> |
max-packet-rate <value>
}
}
Options
> logging Sets logging parameters
> default Restores logging parameters to the default settings
> default-policy-logging Sets the default log policy
> log-suppression Enables or disables log suppression (1-300)
> max-packet-rate value Sets the maximum packet rate for logging (0-50000)
> max-log-rate value Sets the maximum logging rate (0-2560)
Sample Output
The following command enables logging suppression.
username@hostname> set system setting logging log-suppression yes
username@hostname>
show admins
show admins
Displays information about the active firewall administrators.
Syntax
show admins {all}
Options
+ all Lists the names of all administrators
Sample Output
The following command displays administrator information for the 10.0.0.132 firewall.
username@hostname> show admins | match 10.0.0
Admin
From
Type Session-start
Idle-for
-------------------------------------------------------------------------admin
10.0.0.132
Web 02/19 09:33:07
00:00:12s
username@hostname>
show arp
show arp
Displays current Address Resolution Protocol (ARP) entries.
Syntax
show arp <interface_name>
Options
<interface_name> Specifies the interface for which the ARP table is displayed
all Displays information for all ARP tables
ethernet1 Displays information for the specified interface
management Displays management ARP information
Sample Output
The following command displays ARP information for the ethernet1/1 interface.
username@hostname> show arp ethernet1
maximum of entries supported :
default timeout:
total ARP entries in table :
total ARP entries shown :
status: s - static, c - complete, i
8192
1800 seconds
0
0
- incomplete
username@hostname>
show authentication
show authentication
Displays authentication information.
Syntax
show authentication {allowlist | groupdb | groupnames}
Options
> allowlist Displays the authentication allow list
> groupdb Lists the group authentication databases
> groupnames Lists the distinct group names
Sample Output
The following command shows the list of users that are allowed to access the firewall.
username@hostname> show authentication allowlist
vsysname
profilename
username
shared
my-ldap-auth-profilerdtest\administrator
shared
my-ldap-auth-profile
administrator
shared
my-ldap-auth-profile
all
shared
my-rsa-auth-profile
all
shared
local-auth-users
all
shared
auth-kerberos
all
shared
radius-abi
all
shared
test
all
shared
testrd-test\cn=account
operators,cn
=builtin,dc=rd-test,dc=eng,dc=paloaltonetworks,dc=local
...
username@hostname>
show cli
show cli
Displays information about the current CLI session.
Syntax
show cli {idle-timeout | info | permissions}
Options
> idle-timeout Displays timeout information for this administrative session
> info Displays various CLI information
> permissions Displays the information about the user role
Sample Output
The following command shows information about the current CLI session.
username@hostname> show
User
Process ID
Pager
Config Display Format
Vsys configuration mode
Vsys
cli info
: admin
: 19510
: enabled
: default
: enabled
: vsys1
username@hostname>
show clock
show clock
Shows the current time on the firewall.
Syntax
show clock {more}
Options
+ more Displays dataplane time
Sample Output
The following command shows the current time.
username@hostname> show clock
Mon Jun 20 21:03:54 PDT 2011
username@hostname>
show commit-locks
show commit-locks
Displays the list of administrators who hold commit locks.
Syntax
show commit-locks
Options
None
show config
show config
Displays the active configuration.
Syntax
show config
{
audit |
{
base-version <value> |
base-version-no-deletes <value> |
info |
version <value>
}
candidate |
diff |
disk-space |
logdb-quota |
running {xpath <value>} |
saved <value> |
synced
}
Options
> audit Displays config audit information
> base-version Base version to show
> base-version-no-deletes Version with no deletes to show
> info Audit information to show
> version Audit version to show
> candidate Displays the candidate configuration
> diff Displays the differences between the running and candidate configurations
> disk-space Displays filesystem disk space usage
> logdb-quota Displays logdb quotas
> running Displays running configuration
+ xpath XPath of the node to retrieve
> saved Displays saved configuration
> synced Displays configuration last synchronized with HA peer
show config-locks
show config-locks
Displays the list of administrators who hold configuration locks.
Syntax
show config-locks
Options
None
show counter
show counter
Displays system counter information.
Syntax
show counter
{
interface {all | management | <value>} |
management-server
}
Options
> interface Displays system counter information grouped by interface
all Show all interface counters
management Show management interface counter information
> management-server Displays management server counter information
Sample Output
The following command displays all configuration counter information grouped according to interface.
username@hostname> show counter interface
The following command displays all global counter information about the number of file forwards
found.
username@hostname> show counter global name ctd_file_forward
Name:
Value:
Severity:
Category:
ctd_file_forward
0
Informational
ctd
show counter
Aspect:
Description:
pktproc
The number of file forward found
username@hostname>
show fips-mode
show fips-mode
Displays the status of the Federal Information Processing Standards (FIPS) 140-2 mode. For
information about enabling and disabling FIPS mode, refer to Chapter 6, Maintenance Mode.
Syntax
show fips-mode
Options
None
Sample Output
The following command shows that FIPS mode is off.
username@hostname> show fips-mode
off
username@hostname>
show host-info
show host-info
Displays host information logs.
Syntax
show hostinfo
{
anchor <value>
direction {ascending | descending}
num-records <value>
query <value>
sortby <value>
}
Options
+ anchor Specify value to start from
+ direction Specify sort direction (ascending or descending)
+ num-records Specify number of records to include
+ query Specify string to match
+ sortby Specify field to sort on
Sample Output
The following command shows one host info record.
username@hostname> show hostinfo 1
{ "@status":"success","@code":"19", "result" : { "@total-count" : "9", "@
count" : "1", "@prefilter-total-count" : "9", "entry" : [ {"os" : "androi
d", "os-version" : "4.2.1", "managed" : "no", "last-checkin-time" : "2013
/09/06 10:20:35", "enrollment-time" : "2013/09/06 09:20:33", "last-unenro
ll-time" : "2013/09/06 10:20:35", "udid" : "2085017e5fa50f28", "mac-addre
ss" : "60:a4:4c:94:02:0b", "@name" : "60:a4:4c:94:02:0b", "user" : "sound
", "encryption-not-set" : "no", "passcode-not-set" : "no", "device-name"
: "Nexus 7", "device-serial" : "015d4b33e834180d", "model" : "Asus Nexus
7", "phone-number" : "", "iccid" : "", "location" : "37.381890,-121.96779
0"}]}}
username@hostname>
show interface
show interface
Displays information about system interfaces.
Syntax
show interface {<interface_name> | all}
Options
all Displays information for all ARP tables
ethernet1 Displays Mobile Security Manager interface information
management Displays management interface information
Sample Output
The following command displays information about the Mobile Security Manager interface.
username@hostname> show interface ethernet1
show interface
show jobs
show jobs
Displays information about current system processes.
Syntax
show jobs {all | id <value> | pending | processed}
Options
> all Displays information for all jobs
> id number Identifies the process by number (1-4294967296)
> pending Displays recent jobs that are waiting to be executed
> processed Displays recent jobs that have been processed
Sample Output
The following command lists jobs that have been processed in the current session.
username@hostname> show jobs processed
Enqueued
ID
Type Status Result Completed
-------------------------------------------------------------------------2007/02/18 09:34:39
2 AutoCom
FIN
OK 2007/02/18 09:34:40
2007/02/18 09:33:00
1 AutoCom
FIN
FAIL 2007/02/18 09:33:54
username@hostname>
show log
show log
Displays system logs.
Syntax
show log
{
config |
{
client {equal | not-equal} {cli | web} |
cmd {equal | not-equal} {add | clone | commit | create | delete | edit
| get | load-from-disk | move | rename | save-to-diak | set}|
csv-output equal {no | yes} |
direction equal {backward | forward} |
end-time equal <value> |
query equal <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
result {equal | not-equal} {failed | succeeded | unauthorized} |
start-time equal <value>
}
hipmatch |
{
direction equal {backward | forward} |
machinename {equal | not-equal} <name> |
matchname {equal | not-equal} <name> |
matchtype {equal | not-equal} {object | profile} |
os {equal | not-equal} <name> |
query equal <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
src {in | not-in} <ip/netmask> |
srcuser equal <user_name>
}
mdm |
{
csv-output equal {no | yes} |
direction equal {backward | forward} |
end-time equal <value> |
query equal <value> |
receive_time in {last-12-hrs | last-15-minutes | last-24-hrs | last-30days | last-6-hrs | last-60-seconds | last-7-days | last-calendarday | last-calendar-month | last-hour} |
start-time equal <value>
}
system |
{
csv-output equal {no | yes} |
direction equal {backward | forward} |
show log
Options
> config Displays config logs
+ client Client equals or does not equal CLI or Web
+ cmd Command equals or does not equal (press <tab> for list for commands)
+ csv-output Equals CSV output (no or yes)
+ direction Backward or forward direction
+ end-time Ending date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
+ query Equal to query value
+ receive_time Receive time in the last specified time period (press <tab> for list)
+ result Result equals or does not equal failed, succeeded, or unauthorized
+ start-time Starting date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
> hipmatch Displays host IP match logs
+ csv-output Equals CSV output (no or yes)
+ machinename Equals or does not equal machine name
+ matchname Equals or does not equal match name
+ matchtype Equals or does not equal object or profile
+ os Equals or does not equal object
+ query Equal to query value
+ receive_time Receive time in the last specified time period (press <tab> for list)
+ src Source IP address in or not in (x.x.x.x/y or IPv6/netmask)
+ srcuser Equals source user name
> mdm Displays Mobile Security Manager logs
+ csv-output Equals CSV output (no or yes)
+ direction Backward or forward direction
+ end-time Ending date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
+ query Equal to query value
+ receive_time Receive time in the last specified time period (press <tab> for list)
+ start-time Starting date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
> system Displays system logs
+ csv-output Equals CSV output (no or yes)
+ direction Backward or forward direction
+ end-time Ending date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
+ eventid Equals or does not equal value
+ id Equals or does not equal value
+ object Equals or does not equal value
+ opaque Opaque contains substring value
+ query Equal to query value
show log
+ receive_time Receive time in the last specified time period (press <tab> for list)
+ severity Equal to, greater than or equal to, less than or equal to, or not equal to critical, high,
informational, low, or medium
+ start-time Starting date and time YYYY/MM/DD@hh:mm:ss (e.g., 2011/08/01@10:00:00)
+ subtype Equal to subtype value
Sample Output
The following command shows the Mobile Security Manager log.
username@hostname> show log mdm
Domain,Receive Time,Serial #,seqno,actionflags,Type/Content Type,C
onfig Version,Generate Time,User,mac,Virtual System,devname,os,desc,Repea
t Count,errcode,Severity,padding1
2013/05/06 03:15:00
2013/05/06 03:15:00
2013/05/06 03:15:00
2013/05/06 03:15:00
2013/05/06 03:15:00
2013/05/06 03:15:00
2013/05/06 03:15:00
2013/05/06 03:15:00
...
username@hostname>
show malware
show malware
Displays the malware name based on the specified ID.
Syntax
show malware id <value>
Options
<value> Specifies the malware ID
show management-clients
show management-clients
Shows information about internal management server clients.
Syntax
show management-clients
Options
None
Sample Output
The following command shows information about the internal management server clients.
username@hostname> show management-clients
Client PRI
State Progress
------------------------------------------------------------------------routed 30
P2-ok
100
device 20
P2-ok
100
ikemgr 10
P2-ok
100
keymgr 10
init
0
(op cmds only)
dhcpd 10
P2-ok
100
ha_agent 10
P2-ok
100
npagent 10
P2-ok
100
exampled 10
init
0
(op cmds only)
Overall status: P2-ok. Progress: 0
Warnings:
Errors:
show mobile-device
show mobile-device
Shows information about mobile devices.
Syntax
show mobile-device
Options
> hip Show detailed HIP information
> device-id Specify device ID
> device-mac Specify device MAC address
> imported-devices Show imported devices and tags
> list
List mobile devices
+ limit Specify limit value
+ offset Specify offset value
> pending-actions Show devices with pending actions
+ limit Specify limit value
+ offset Specify offset value
+ query Specify device filter
Sample Output
The following command lists the known mobile devices.
username@hostname> show mobile-device list
Name
User
Model Product Status MAC
Device-ID
--------------------------------------------------------------------------Dev iPad 2
sound
iPad 2
iPad2,2 unmanaged 04:54:53:31:e0:77
c6e1a5f156fa79e786946ebed0509f29a5e1a1d0
Nexus 7
sound
Asus Nexus 7 nakasi
unmanaged 60:a4:4c:94:02:0b
2085017e5fa50f28
iPod touch
sound
iPod touch 5 iPod5,1 unmanaged 02:00:00:00:00:00
881a41cd3182311ad1fcaffbec16bcbf0d9c139a
bhu
unmanaged 10:BF:48:CD:4A:2D
3e9ff108c86632fa
show operational-mode
show operational-mode
Displays the device operational mode.
Syntax
show operational-mode
Options
None
Sample Output
The following command shows the device operational mode.
username@hostname> show operational-mode
normal
username@hostname>
show query
show query
Displays information about query jobs.
Syntax
show query {id <value> | jobs}
Options
> id Displays job information for the specified ID (1-4294967296)
> jobs Displays all job information
Sample Output
The following command shows information about all current query jobs.
username@hostname> show query jobs
Enqueued
ID Last Upd
-------------------------------------------------------------------------13:58:19
16 13:58:19
Type
ID Dequeued?
----------------------------------------------------username@hostname>
show report
show report
Displays information about process jobs.
Syntax
show report
{
directory-listing |
id <value> |
jobs |
}
Options
> directory-listing Displays report of directory listings
> id Displays reports by ID (1-4294967296)
> jobs Reports all jobs
Sample Output
The following command shows the report of directory listings.
username@hostname> show report directory-listing
/opt/pancfg/mgmt/custom-reports:
total 44K
drwxr-xr-x 2 root root 4.0K Jan 12 02:02 test
drwxr-xr-x 2 root root 20K Jan 14 02:02 test-report
drwxr-xr-x 2 root root 20K Jan 14 02:02 test-hip-report
/opt/pancfg/mgmt/custom-reports/test:
total 184K
-rw-r--r-- 1 root root 1.6K May 7 2013 604800s-ending-20130506.xml
-rw-r--r-- 1 root root 1.9K May 8 2013 604800s-ending-20130507.xml
-rw-r--r-- 1 root root 2.5K May 9 2013 604800s-ending-20130508.xml
username@hostname>
show system
show system
Displays system-related information.
Syntax
show system
{
disk-space |
environmentals {fans | power | thermal} |
files |
info |
logdb-quota |
masterkey-properties |
raid {detail} |
resources {follow} |
services |
setting mp-memory-monitor |
software status |
state {browser | filter | filter-pretty} |
}
Options
> disk-space Reports file system disk space usage
> environmentals Displays system environment state
> files Lists important files in the system
> info Displays system information
> log-summary status Reports time of last generated thsum and trsum logs
> logdb-quota Reports log data base quotas
> masterkey-properties Displays Master key expiry and reminders times
> raid Displays status of RAID devices
> resources Displays system resources
> services Displays system services
> setting Displays system settings for memory management
> software Displays software information
> state Displays system state
> browser Navigate in a text-mode browser
> filter Filter by subtree/wildcard
> filter-pretty Filter by subtree/wildcard with pretty printing
> statistics Displays system statistics
> application Displays application statistics for the specified virtual system
> session Displays statistics for the session
Sample Output
The following command displays system information.
username@hostname> show system info
hostname: GP-100
ip-address: 10.5.36.5
netmask: 255.255.255.0
show system
default-gateway: 10.5.36.1
mac-address: 00:21:cc:da:04:3e
ethernet1-ip-address: 192.168.1.5
ethernet1-netmask: 255.255.255.0
ethernet1-default-gateway: 192.168.1.1
time: Tue Jan 14 10:28:01 2014
uptime: 10 days, 18:49:26
family: m
model: GP-100
serial: 009801000004
sw-version: 6.0.0-b58
mdmbase-version: 233-507
mdmapp-version: 181-432
mdmapp-release-date: 2014/01/13 13:09:14
logdb-version: 6.0.6
platform-family: m
username@hostname>
The following command displays log database quotas and disk usage.
username@hostname> show system logdb-quota
Quotas:
system:
config:
hipmatch:
mdm:
10.00%,
10.00%,
30.00%,
20.00%,
5.044 GB
5.044 GB
15.133 GB
10.088 GB
Disk usage:
system: Logs and Indexes: 16M
config: Logs and Indexes: 246M
alarm: Logs and Indexes: 28K
hipmatch: Logs and Indexes: 20M
mdm: Logs and Indexes: 25M
show user
show user
Displays user identification information. You can show information for a specified IP address, user, or
all.
Syntax
show user
directory-integration |
{
naming-context |
{is-active-directory {no | yes}|
server-port <value> |
use-ssl {no | yes}|
server {<ip/netmask> | <hostname>} |
state {all | <value>} |
statistics
}
group |
{
list |
+ xmlapi
| {except <value>| match <value>}
name <value>}
}
group-selection server {<ip/netmask> | <host_name>} |
{
base <value> |
bind-dn <value> |
bind-password <value> |
container-object <value> |
filter <value> |
force {no | yes} |
group-object <value> |
name-attribute <value> |
search-scope {one | subtree} |
server <value> |
server-port <value> |
use-ssl {no | yes}
}
local-user-db |
{
disabled {no |yes} |
username <name> |
vsys <name>
}
name <value>
}
show user
Options
> directory-integration Displays user groups data
> naming-context Show naming context for directory server
+ is-active-directory is-active-directory
+ server-port ldap server listening port
+ use-ssl use-ssl
* server ldap server ip or host name.
> state Show state of one or all group mapping data (specify all or value)
> statistics Show group mapping statistics
> group Displays user groups data
> list Lists all groups
+xml_api Lists groups from XML API
> name Displays group's members
> group-selection Show members under one container
+ base Default base distinguished name (DN) to use for searches
+ bind-dn Bind distinguished name
+ bind-password Bind password
+ container-object Container object class (comma-separated)
+ filter Search filter
+ force Whether to force
+ group-object Group object class (comma-separated)
+ name-attribute Name attribute
+ use-ssl Whether to use SSL
+ search-scope Search scope (one or subtree)
> server-port LDAP server listening port (1-65535)
> server LDAP server IP address/network mask or host name
> local-user-db Displays the local user database
+ disabled Filters by disabled/enabled
+ username Specifies user name
+ vsys Specifies virtual system name
> name Displays statistics for the specified user
Sample Output
The following command indicates group membership for the user Amy.
username@hostname> show user name amy
User 'amy' is in 0 group
username@hostname>
ssh
ssh
Opens a secure shell (SSH) connection to another host.
Syntax
ssh host <value>
{
inet {no | yes} |
port <port_number> |
source <ip_address> |
v1 {no | yes} |
v2 {no | yes}
}
Options
+ inet Force to IPv4 destination
+ port Port to connect to on the remote host (1-65535; default = 22))
+ source Source address for SSH session
+ v1 Force SSH to try protocol version 1 only (default = version 2)
+ v2 Force SSH to try protocol version 2 only
* host Host name or IP address of remote host
Sample Output
The following command opens an SSH connection to host 10.0.0.250 using SSH version 2.
username@hostname> ssh v2 [email protected]
[email protected]'s password:
#
tail
tail
Prints the last 10 lines of a debug file.
Note: The dp-log option will not be available on devices that do not have a dataplane, such as the PA200.
Syntax
tail
{
follow {no | yes} |
lines <value> |
dp-log <file> |
mp-log <file> |
webserver-log <file>
}
Options
+ follow Outputs appended data as the file grows
+ lines Outputs the last N lines, instead of the last 10 (1-65535)
> dp-log Data plane log file to display (press <tab> for list of files)
> mp-log Management plane log file to display (press <tab> for list of files)
> webserver-log Web server log file to display (press <tab> for list of files)
Sample Output
The following command displays the last 10 lines of the mappdb.log file.
username@hostname> tail db-log mappdb.log
Tue Jan 14 10:31:33.439 [initandlisten] connection accepted from
127.0.0.1:44878 #15523 (5 connections now open)
Tue Jan 14 10:31:33.442 [conn15523] end connection 127.0.0.1:44878
connections now open)
Tue Jan 14 10:32:33.495 [initandlisten] connection accepted from
127.0.0.1:44888 #15524 (5 connections now open)
Tue Jan 14 10:32:33.498 [conn15524] end connection 127.0.0.1:44888
connections now open)
Tue Jan 14 10:33:33.550 [initandlisten] connection accepted from
127.0.0.1:44897 #15525 (5 connections now open)
Tue Jan 14 10:33:33.553 [conn15525] end connection 127.0.0.1:44897
connections now open)
Tue Jan 14 10:34:33.606 [initandlisten] connection accepted from
127.0.0.1:44912 #15526 (5 connections now open)
Tue Jan 14 10:34:33.609 [conn15526] end connection 127.0.0.1:44912
connections now open)
Tue Jan 14 10:35:33.662 [initandlisten] connection accepted from
127.0.0.1:44937 #15527 (5 connections now open)
Tue Jan 14 10:35:33.664 [conn15527] end connection 127.0.0.1:44937
connections now open)
username@hostname>
(4
(4
(4
(4
(4
username@hostname>
tail
test
test
Runs tests based on installed security policies.
Syntax
test
{
mdm {
hip-report distribute {device-id <value> type <value>}
log {
hip-match {device <value> | object <value> | os <value> | username
<value>} |
mdm {device-id <value> | os <value> | type <value> | username
<value>} |
}
scp-server-connection |
{
confirm hostname <value> key <value> |
initiate hostname <value> password <value> username <value> {path
<value> | port <value>}
}Options
> mdm
> hip-report distribute Tests Mobile Security Manager
* device-id Device ID
* type Type
> log Test log operation
* hip-matchTest hipmatch log (specify device name, object, os, or user name)
* mdm Test Mobile Security Manager log (specific device ID, os, type, or user name)
> scp-server-connection Tests SCP server connection
> confirm Confirms SCP server connection
* hostname Specifies an SCP hostname
* key Specifies an RSA key
> initiate Initiates SCP server connection
+ path Specifies an SCP path
+ port Specifies an SCP port (1-65535)
* hostname Specifies an SCP hostname
* password Specifies an SCP password
* username Specifies an SCP username
traceroute
traceroute
Displays information about the route packets take to another host.
Syntax
traceroute host <value>
{
bypass-routing {no | yes} |
debug-socket {no | yes} |
do-not-fragment {no | yes} |
first-ttl <value> |
gateway <value> |
ipv4 {no | yes} |
ipv6 {no | yes} |
max-ttl <value> |
no-resolve {no | yes} |
pause <value> |
port <value> |
source <ip_address> |
tos <value> {verbose} |
wait <value>
}
Options
+ bypass-routing Sends the request directly to the host on a direct attached network, bypassing usual routing
table
+ debug-socket Enables socket-level debugging
+ do-not-fragment Sets the do-not-fragment bit
+ first-ttl Sets the time-to-live (in number of hops) in the first outgoing probe packet
+ gateway Specifies a loose source router gateway (maximum = 8)
+ ipv4 Specifies that IPv4 is used
+ ipv6 Specifies that IPv6 is used
+ max-ttl Sets the maximum time-to-live in number of hops
+ no-resolve Does not attempt to print resolved domain names
+ pause Sets the time to pause between probes (in milliseconds)
+ port Sets the base port number used in probes (default for UDP = 33434; for TCP = 80; for ICMP = 1)
+ source Specifies the source IP address in outgoing probe packets
+ tos Specifies the type of service (TOS) treatment for the packets by way of the TOS bit for the IP header in the
ping packet (0-255)
+ wait Specifies a delay in transmission of the traceroute request (in seconds)
* host Specifies the IP address or name of the remote host (required)
traceroute
Sample Output
The following command displays information about the route from the firewall to www.google.com.
username@hostname> traceroute www.paloaltonetworks.com
traceroute to www.paloaltonetworks.com (72.32.199.53), 30 hops max, 38 byte
packets
1 10.1.0.1 (10.1.0.1) 0.399 ms 1.288 ms 0.437 ms
2 64.0.27.225.ptr.us.xo.net (64.0.27.225) 1.910 ms dsl027-186189.sfo1.dsl.speakeasy.net (216.27.186.189) 1.012 ms
64.0.27.225.ptr.us.xo.net (64.0.27.225) 1.865 ms
3 dsl027-182-001.sfo1.dsl.speakeasy.net (216.27.182.1) 16.768 ms 581.420
ms 64.3.142.37.ptr.us.xo.net (64.3.142.37) 219.190 ms
4 ge5-0-0.mar2.fremont-ca.us.xo.net (207.88.80.21) 228.551 ms 110.ge-0-00.cr1.sfo1.speakeasy.net (69.17.83.189) 12.352 ms ge5-0-0.mar2.fremontca.us.xo.net (207.88.80.21) 218.547 ms
5 ge-5-3-0.mpr3.pao1.us.above.net (209.249.11.177) 13.212 ms p4-00.rar2.sanjose-ca.us.xo.net (65.106.5.137) 273.935 ms 221.313 ms
6 p1-0.ir1.paloalto-ca.us.xo.net (65.106.5.178) 139.212 ms so-1-21.mpr1.sjc2.us.above.net (64.125.28.141) 13.348 ms p1-0.ir1.paloaltoca.us.xo.net (65.106.5.178) 92.795 ms
7 so-0-0-0.mpr2.sjc2.us.above.net (64.125.27.246) 12.069 ms
206.111.12.146.ptr.us.xo.net (206.111.12.146) 93.278 ms so-0-00.mpr2.sjc2.us.above.net (64.125.27.246) 556.033 ms
8 tbr1p013201.sffca.ip.att.net (12.123.13.66) 52.726 ms so-3-20.cr1.dfw2.us.above.net (64.125.29.54) 61.875 ms
tbr1p013201.sffca.ip.att.net (12.123.13.66) 58.462 ms
MPLS Label=32537 CoS=0 TTL=1 S=1
9
Chapter 6
Maintenance Mode
Maintenance mode provides support for error recovery and diagnostics, and allows you to reset the
firewall to factory defaults.
This chapter describes how to enter Maintenance mode:
Serial cable to the serial port on the firewall. For serial cable specifications, refer to the Hardware
Reference Guide for your firewall model.
Secure Socket Layer (SSL). SSL access is supported if the firewall has already entered
Maintenance mode (either automatically or explicitly during bootup).
2.
Press any key on your keyboard when prompted to stop the automatic boot, and then select maint
as the booting partition.
The following table describes the Maintenance mode selections that are accessible without entering a
password.
Description
Maintenance Entry
Reason
Indicates why the system entered Maintenance mode and includes possible recovery
steps.
Displays basic information about the system. This information is useful when
obtaining assistance from Customer Support.
Provides the ability to run a file system check (FSCK) on various partitions.
Log Files
Disk Image
Allows the system to revert back to the previously installed software version.
Content Rollback
Reboot
Some of the options are password protected to prevent accidental changes that could leave the system in
an inoperative state. The password is intended as a safeguard and it not meant to be secret. The
password is MA1NT (numeral 1).
Description
Factory Reset
Returns the firewall into the factory default state. The reset includes an option to scrub
the Config and Log partitions using a National Nuclear Security Administration
(NNSA) or Department of Defense (DOD) compliant scrubbing algorithm. Scrubbing
can take up to six hours to complete.
Note: After resetting to the factory default state, you must power cycle the device.
Enables and disables FIPS mode. For more information about support for FIPS 140-2,
refer to the Federal Information Processing Standards Support appendix in the Palo
Reprograms the main bootloader with the latest bootloader image on the system. Use
this option if the failsafe bootloader is running and recovery of the main bootloader is
required. (PA-2000 and PA-500 systems only)
Disk Image
Advanced
These options provide greater granularity and control over installation, including status,
history, bootstrapping, and other commands.
Diagnostics
Tests the data plane booting and data plane memory, and run disk performance with
bonnie++.
Appendix A
PAN-OS CLI KEYBOARD SHORTCUTS
This appendix lists the supported keyboard shortcuts and control characters supported in the PAN-OS
Command Line Interface.
Note: Some shortcuts depend upon the SSH client that is used to access the PAN-OS CLI. For
some clients, the Meta key is the Control key; for some it is the Esc key.
Description
end-of-line (C-e)
forward-char (C-f)
backward-char (C-b)
forward-word (M-f)
Move forward to the end of the next word. Words consist of alphanumeric
characters (letters and digits).
backward-word (M-b)
Move back to the start of this, or the previous, word. Words consist of
alphanumeric characters (letters and digits).
clear-screen (C-l)
Clear the screen and place the current line at the top of the screen. If an
argument is included, refresh the current line without clearing the screen.
Accept the line regardless of where the cursor is. If the line is non-empty,
add it to the history list. If the line is a modified history line, then restore
the history line to its original state.
previous-history (C-p)
Fetch the previous command from the history list, moving back in the list.
next-history (C-n)
Fetch the next command from the history list, moving forward in the list.
beginning-of-history (M-<)
end-of-history (M->)
Move to the end of the input history (the line currently being entered).
reverse-search-history (C-r)
Search backward starting at the current line and moving up through the
history as necessary. This is an incremental search.
771
Description
forward-search-history (C-s)
Search forward starting at the current line and moving down through the
history as necessary. This is an incremental search.
non-incremental-reverse-searchhistory (M-p)
Search backward through the history starting at the current line using a
non-incremental search for a string supplied by the user.
non-incremental-forward-searchhistory (M-n)
Delete the character under the cursor. If point is at the beginning of the
line, there are no characters in the line, and the last character typed was not
C-d, then return EOF.
Delete the character behind the cursor.
transpose-chars (C-t)
Drag the character before point forward over the character at point. Point
moves forward as well. If point is at the end of the line, then transpose the
two characters before point.
transpose-words (M-t)
Drag the word behind the cursor past the word in front of the cursor
moving the cursor over that word as well.
upcase-word (M-u)
downcase-word (M-l)
capitalize-word (M-c)
Delete the text from the current cursor position to the end of the line.
unix-line-discard (Cu)
kill-word (M-d)
Delete from the cursor to the end of the current word, or if between words,
to the end of the next word. Word boundaries are the same as those used by
forward-word.
backward-kill-word (Mbackspace)
Delete the word behind the cursor. Word boundaries are the same as those
used by backward-word.
unix-word-backspace
(C-w)
Delete the word behind the cursor, using white space as a word boundary.
The word boundaries are different from backward-kill-word.
yank (C-y)
Place the top of the deleted section into the buffer at the cursor.
yank-pop (M-y)
Rotate the kill-ring, and yank the new top. Only works following yank or
yank-pop.
Completing Commands
772
complete (TAB)
possible-completions
(?)
Description
revert-line (M-r)
Undo all changes made to this line. This is like typing the undo command
enough times to return the line to its initial state.
Table 7 lists the CLI control characters. The control characters used in the CLI are similar to those used
in the EMACS editor.
Description
Standard bindings
C-A
beginning-of-line
C-B
backward-char
C-D
delete-char
C-E
end-of-line
C-F
forward-char
C-G
abort
C-H
backward-delete-char
C-I
complete
C-J
accept-line
C-K
kill-line
C-L
clear-screen
C-M
accept-line
C-N
next-history
C-P
previous-history
C-R
reverse-search-history
C-S
forward-search-history
C-T
transpose-chars
C-U
unix-line-discard
C-W
unix-word-backspace
C-Y
yank
C-_
undo
Meta bindings
M-C-H
backward-kill-word
M-C-R
revert-line
M-<
beginning-of-history
773
774
Command
Description
M->
end-of-history
possible-completions
M-B
backward-word
M-C
capitalize-word
M-D
kill-word
M-F
forward-word
M-L
downcase-word
M-N
non-incremental-forward-search-history
M-P
non-incremental-reverse-search-history
M-R
revert-line
M-T
transpose-words
M-U
upcase-word
M-Y
yank-pop
Index
Symbols
? symbol 17
# prompt 15
+ option symbol 19
> option symbol 19
> prompt 15
| pipe symbol 19, 20
hierarchy paths 27
configuration mode
hierarchy 26
prompt 15
understanding 23
configure command 312, 672
control key 18
copy command 39, 591
critical errors, switching to maintenance mode 767
banner 15, 28
bootloader recovery 769
bootup 766
C
CC mode 430, 717
changing modes 16
check command 37, 589
clear command 305, 671
CLI
accessing 14
configuration mode 13
EMACS commands 773
keyboard shortcuts 771
operational model 13
prompt 15
structure 13
collectors 102
commands 30
conventions 15
display 30
messages 16
monitoring and troubleshooting 30
navigation 30
network access 30
option symbols 19
options 17
understanding 15
commit command 23, 38, 590
commit-all command 311
configuration
hierarchy 26
775 Index
E
edit banner 28
edit command
banner 15
using 29, 41, 593
errors, switching to maintenance mode 767
esc key 18
Ethernet interfaces 21
ethernet1/n 21
exit command 42, 379, 380, 594, 689
F
factory reset 769
file system check (FSCK) 769
find command 43, 595
FIPS mode 430, 717, 769
ftp command 381, 690
G
getting started 14
grep command 382, 691
H
hierarchy
configuration 26
navigating 28
new elements 28
paths 27
hostname 15
I
interfaces 21
K
keyboard shortcuts 18, 771
L
less command 383, 692
load command 44, 596
log collection 102
ls command 384, 693
M
maintenance mode
about 765
diagnostics 769
entering automatically 767
entering upon bootup 766
password 769
serial console message 767
SSH message 768
web interface message 767
776 Index
meta key 18
modes
changing 16, 17
configuration 23
operational 30
move command 46, 598
N
navigating hierarchy 28
netstat command 385, 694
O
operational mode
command types 30
prompt 15
using 30
override command 47, 599
P
packet capture 327
Panorama-managed collectors 102
password, maintenance mode 769
ping command 387, 696
pipe symbol 20
privilege levels 21
Q
quit command 48, 389, 600, 698
R
rename command 49, 601
request acknowledge command 390
request analyze-shared-policy command 391
request anti-virus command 392
request batch command 394
request certificate command 400, 402, 699
request commit-lock command 403, 701
request config-backup command 404
request config-lock command 405, 702
request content upgrade command 406, 703
request data-filtering command 408
request device-registration command 409, 705
request dhcp command 410
request generate-report command 706
request global-protect-client command 411
request global-protect-gateway command 412, 707
request global-protect-portal command 413
request global-protect-satellite command 414
request high-availability command 415
request hsm command 416
request last-acknowledge-time command 417
request license command 418, 708
request log-fwd-ctrl command 419
request master-key command 420, 709
request password-change-history command 421, 710
request password-hash command 422, 711
S
save command 23, 51, 603
schedule command 435
scp export command 437, 720
scp import command 440, 721
self-test 430, 717
serial console
maintenance mode 765
message 767
set address command 52
set address-group command 53
set application command 54
set application dump command 442
set application-filter command 57
set application-group command 58
set captive-portal command 59
set cli command 444, 447, 723, 726
set clock command 446, 725
set command 251, 649
set deviceconfig high-availability command 63
set deviceconfig setting command 71, 604
set deviceconfig system command 82, 607
set device-group command 61
set directory-integration command 615
set display-name command 92
set email-scheduler command 93
set external-list command 94
set global-protect command 95, 616
set group-mapping command 101
set icon command 618
set log-collector command 102
set log-collector-group command 105
set management-server command 448, 727
set mgt-config command 113, 619
set network dhcp command 116
set network dns-proxy command 118
set network ike command 120
set network interface command 124
set network profiles command 138
set network qos command 144
set network shared-gateway command 146
set network tunnel command 155
set network virtual-router bgp command 166
set network virtual-router command 161
set network virtual-router multicast command 163
set network virtual-router ospf command 178
Index 777
778 Index
T
tail command 570, 760
target command 571
tcpdump command 572
test command 573, 762
tftp export command 578
tftp import command 580
top command 29, 296, 666
traceroute command 582, 763
U
up command 29, 297, 667
user name 15
user privileges 21
V
view-pccap command 584