Pan-Os-Cli-Quick-Start - 10.0
Pan-Os-Cli-Quick-Start - 10.0
Version 10.0
paloaltonetworks.com/documentation
Contact Information
Corporate Headquarters:
Palo Alto Networks
3000 Tannery Way
Santa Clara, CA 95054
www.paloaltonetworks.com/company/contact-support
Copyright
Palo Alto Networks, Inc.
www.paloaltonetworks.com
© 2020-2021 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo
Alto Networks. A list of our trademarks can be found at www.paloaltonetworks.com/company/
trademarks.html. All other marks mentioned herein may be trademarks of their respective companies.
Last Revised
April 28, 2021
iv TABLE OF CONTENTS
Get Started with the CLI
Every Palo Alto Networks device includes a command-line interface (CLI) that allows you to
monitor and configure the device. Although this guide does not provide detailed command
reference information, it does provide the information you need to learn how to use the CLI. It
includes information to help you find the command you need and how to get syntactical help
after you find it. It also explains how to verify the SSH connection to the firewall when you
access the CLI remotely, and how to refresh the SSH keys and configure key options when
connecting to the management interface.
5
6 PAN-OS CLI QUICK START | Get Started with the CLI
© 2021 Palo Alto Networks, Inc.
Access the CLI
Use a terminal emulator, such as PuTTY, to connect to the CLI of a Palo Alto Networks device in one of the
following ways:
• SSH Connection—To ensure you are logging in to your firewall and not a malicious device, you can verify
the SSH connection to the firewall when you perform initial configuration. After you have completed
initial configuration, you can establish a CLI connection over the network using a secure shell (SSH)
connection.
• Serial Connection—If you have not yet completed initial configuration or if you chose not to enable SSH
on the Palo Alto Networks device, you can establish a direct serial connection from a serial interface on
your management computer to the Console port on the device.
STEP 1 | Launch the terminal emulation software and select the type of connection (Serial or SSH).
• To establish an SSH connection, enter the hostname or IP address of the device you want to connect
to and set the port to 22.
• To establish a Serial connection, connect a serial interface on management computer to the Console
port on the device. Configure the Serial connection settings in the terminal emulation software as
follows:
• Data rate: 9600
• Data bits: 8
• Parity: none
• Stop bits: 1
• Flow control: none
username@hostname>
You can tell you are in operational mode because the command prompt ends with a >.
To ensure you are logging in to your firewall, perform this task when you first access your
firewall remotely (when you Perform Initial Configuration) and whenever you change the
default host key type or regenerate the host keys for the management port.
STEP 1 | Perform Initial Configuration and note the fingerprints that the firewall displays upon booting
up.
When you connect to the console port (Step 3 of Perform Initial Configuration), the firewall boots up
and displays SSH fingerprints. Make note of these fingerprints.
If the firewall is in FIPS-CC mode, it displays the fingerprints in sha1 hash in base64 encoding, as in the
following example:
SSH Fingerprints
-------------------
256 +nvDTw9G6FpjVRYCN7qYWMmZxB0 (ECDSA)
384 Slx984ndSKeRU+YOkNh9R/4u8IM (ECDSA)
521 sph8wuC3Y/p6zvFr0sGnrzim3wo (ECDSA)
2048 kK3+bBRaJpJQOM+qE8Bl9SKCQPg (RSA)
3072 gtFBWm65/+D7dqUdDDc3P6hJu1g (RSA)
4096 CQnLFnMF1BfBwV7y5bhYQyawpcc (RSA)
If the firewall is in non-FIPS-CC mode, it displays the fingerprints in md5 hash in hex encoding, as in the
following example:
SSH Public key fingerprints:
256 5c:73:5c:88:ea:ba:04:f7:9a:72:07:67:74:20:0c:09 (ECDSA)
384 f2:69:5c:0b:e2:26:e1:39:ca:2f:46:00:df:d5:aa:c0 (ECDSA)
521 8f:00:fa:d0:b9:a5:c5:4d:9d:f5:cd:0d:2c:86:99:25 (ECDSA)
2048 0c:01:69:54:1e:21:08:9d:65:37:3b:50:4a:03:70:d6 (RSA)
3072 1f:ae:d8:1a:b6:8d:9a:4b:c2:fd:74:ca:dc:4f:ca:19 (RSA)
4096 38:88:fb:62:07:19:cf:89:88:a0:6d:22:4b:fa:f4:23 (RSA)
The following example displays SSH server fingerprints in hex format and md5 hash type.
admin@PA-3060> show ssh-fingerprints format hex hash-type md5
SSH Public key fingerprints:
256 5c:73:5c:88:ea:ba:04:f7:9a:72:07:67:74:20:0c:09 (ECDSA)
384 f2:69:5c:0b:e2:26:e1:39:ca:2f:46:00:df:d5:aa:c0 (ECDSA)
521 8f:00:fa:d0:b9:a5:c5:4d:9d:f5:cd:0d:2c:86:99:25 (ECDSA)
2048 0c:01:69:54:1e:21:08:9d:65:37:3b:50:4a:03:70:d6 (RSA)
3072 1f:ae:d8:1a:b6:8d:9a:4b:c2:fd:74:ca:dc:4f:ca:19 (RSA)
4096 38:88:fb:62:07:19:cf:89:88:a0:6d:22:4b:fa:f4:23 (RSA)
STEP 3 | Continue to Perform Initial Configuration on the firewall so that you assign an IP address to the
management interface and commit your changes.
STEP 5 | Initiate remote access to the firewall and view the fingerprint.
Using terminal emulation software, such as PuTTY, launch an SSH management session to the firewall
using the IP address you assigned to it.
To verify your SSH connection to the firewall after you have regenerated a host key or
changed the default host key type, perform a procedure similar to this one, starting with
logging in to the console port. In this case, Step 2 is required; execute the show ssh-
fingerprints CLI command (with the applicable format and hash-type) and note the
one fingerprint that displays. Omit Step 3 and continue with Step 4, finishing the rest of
the procedure. Verify that the fingerprint from the SSH client matches the fingerprint you
noted from Step 2.
If you are using SSH to access the CLI of the firewall in FIPS-CC mode, you must set
automatic rekeying parameters for session keys.
Palo Alto Networks allows you to specify only recommended ciphers, key exchange
algorithms, and message authentication algorithms for the SSH configurations below.
Also note that, to use the same SSH connection settings for each Dedicated Log Collector
(M-Series or Panorama™ virtual appliances in Log Collector mode) in a Collector Group,
you must configure an SSH service profile from the Panorama management server, Commit
the changes to Panorama, and then Push the configuration to the Log Collectors. You can
use the set log-collector-group <name> general-setting management ssh
commands.
Each of the following configuration steps includes a commit and an SSH service restart if you
perform only one step (except when you create a profile without configuring any settings).
Otherwise, you can set multiple SSH options and then commit your changes and restart SSH
when you’re done.
• Create an SSH service profile to exercise greater control over SSH connections to your
management interface.
This example creates a Management - Server profile without configuring any settings.
1. admin@PA-3260> configure
2. admin@PA-3260# set deviceconfig system ssh profiles mgmt-profiles server-
profiles <name>
3. admin@PA-3260# commit
4. admin@PA-3260# exit
5. To verify that the new profile has been created and view the settings for any existing profiles:
admin@PA-3260> configure
admin@PA-3260# show deviceconfig system ssh profiles
• (Optional) Set the SSH server to use only the specified encryption ciphers.
By default, SSH allows all supported ciphers for encryption of CLI management sessions. When you
set one or more ciphers in an SSH service profile, the SSH server advertises only those ciphers while
connecting and, if the SSH client tries to connect using a different cipher, the server terminates the
connection.
1. admin@PA-3260> configure
• (Optional) Delete a cipher from the set of ciphers you selected to encrypt your CLI sessions.
This example deletes the AES CBC cipher with 128-bit key.
1. admin@PA-3260> configure
2. admin@PA-3260# delete deviceconfig system ssh profiles mgmt-profiles
server-profiles <name> ciphers aes128-cbc
3. admin@PA-3260# commit
4. admin@PA-3260# exit
• (Optional) Set the session key exchange algorithms the SSH server will support.
By default, the SSH server advertises all the key exchange algorithms to the SSH client.
If you are using an ECDSA default key type, best practice is to use an ECDH key
algorithm.
1. admin@PA-3260> configure
2. admin@PA-3260# set deviceconfig system ssh profiles mgmt-profiles server-
profiles <name> kex <value>
diffie-hellman-group14-sha1—Diffie-Hellman group 14 with SHA1 hash
ecdh-sha2-nistp256—(Recommended) Elliptic-Curve Diffie-Hellman over National Institute of
Standards and Technology (NIST) P-256 with SHA2-256 hash
ecdh-sha2-nistp384—(Recommended) Elliptic-Curve Diffie-Hellman over NIST P-384 with
SHA2-384 hash
ecdh-sha2-nistp521—(Recommended) Elliptic-Curve Diffie-Hellman over NIST P-521 with
SHA2-521 hash
3. admin@PA-3260# commit
4. admin@PA-3260# exit
5. admin@PA-3260> set ssh service-restart mgmt
6. To verify the key exchange algorithms have been updated:
admin@PA-3260> configure
admin@PA-3260# show deviceconfig system ssh profiles mgmt-profiles server-
profiles
• (Optional) Set the message authentication codes (MAC) the SSH server will support.
By default, the server advertises all of the MAC algorithms to the client.
1. admin@PA-3260> configure
2. admin@PA-3260# set deviceconfig system ssh profiles mgmt-profiles server-
profiles <name> mac <value>
hmac-sha1—MAC with SHA1 cryptographic hash
hmac-sha2-256—(Recommended) MAC with SHA2-256 cryptographic hash
hmac-sha2-512—(Recommended) MAC with SHA2-512 cryptographic hash
3. admin@PA-3260# commit
4. admin@PA-3260# exit
5. admin@PA-3260> set ssh service-restart mgmt
6. To verify the MAC algorithms have been updated:
admin@PA-3260> configure
• (Optional) Regenerate ECDSA or RSA host keys for SSH to replace the existing keys.
The remote device uses the host keys to authenticate the firewall. Regenerate your default host key at
the frequency you determine necessary for security purposes. This example regenerates the ECDSA 256
default host key because that is the default host key type set in an earlier step.
Regenerating a host key does not change your default host key type. To regenerate the
default host key you are using, you must specify your default host key type and length
when you regenerate. Regenerating a host key that isn’t your default host key type simply
regenerates a key that you aren’t using and therefore has no effect.
1. admin@PA-3260> configure
2. admin@PA-3260# set deviceconfig system ssh regenerate-hostkeys mgmt key-
type ECDSA key-length 256
3. admin@PA-3260# commit
4. admin@PA-3260> exit
5. admin@PA-3260> set ssh service-restart mgmt
• (Optional) Set rekey parameters to establish when automatic rekeying of the session keys
occurs.
The session keys are used to encrypt traffic between the remote device and the management interface.
The parameters you can set are data volume (in megabytes), time interval (seconds), and packet count.
After any one rekey parameter reaches its configured value, SSH initiates a key exchange.
You can set a second or third parameter if you aren’t sure the parameter you configured will reach its
value as fast as you want rekeying to occur. The first parameter to reach its configured value will prompt
a rekey, then the firewall will reset all rekey parameters.
1. admin@PA-3260> configure
2. admin@PA-3260# set deviceconfig system ssh profiles mgmt-profiles server-
profiles <name> session-rekey data 32
Rekeying occurs after the volume of data (in megabytes) is transmitted following the previous rekey.
The default is based on the cipher you use and ranges from 1GB to 4GB. The range is 10MB to
4,000MB. Alternatively, you can enter set deviceconfig system ssh profiles mgmt-
profiles server-profiles <name> session-rekey data default, which sets the data
parameter to the default value of the individual cipher you are using.
3. admin@PA-3260# set deviceconfig system ssh profiles mgmt-profiles server-
profiles <name> session-rekey interval 3600
Rekeying occurs after the specified time interval (in seconds) passes following the previous rekey. By
default, time-based rekeying is disabled (set to none). The range is 10 to 3,600.
If you are configuring the management interface in FIPS-CC mode, you must set a
time interval within the range; you cannot leave it disabled.
4. admin@PA-3260# set deviceconfig system ssh profiles mgmt-profiles server-
profiles <name> session-rekey packets 27
n
Rekeying occurs after the defined number of packets (2 ) are transmitted following the previous
14
rekey. For example, 14 configures that a maximum of 2 packets are transmitted before a rekey
28 12 27
occurs. The default is 2 . The range is 12 to 27 (2 to 2 ). Alternatively, you can enter set
Choose rekeying parameters based on your type of traffic and network speeds (in
addition to FIPS-CC requirements if they apply to you). Don’t set the parameters so
low that they affect SSH performance.
5. admin@PA-3260# commit
6. admin@PA-3260# exit
7. admin@PA-3260> set ssh service-restart mgmt
8. To verify the changes:
admin@PA-3260> configure
admin@PA-3260# show deviceconfig system ssh profiles mgmt-profiles server-
profiles <name> session-rekey
• Activate the profile by selecting the profile and restarting SSH service.
1. admin@PA-3260> configure
2. admin@PA-3260# set deviceconfig system ssh mgmt server-profile <name>
3. admin@PA-3260# commit
4. admin@PA-3260# exit
5. admin@PA-3260> set ssh service-restart mgmt
6. To verify the correct profile is in use:
admin@PA-3260> configure
admin@PA-3260# show deviceconfig system ssh mgmt
Administrative Privileges
Privilege levels determine which commands an administrator can run as well as what information is
viewable. Each administrative role has an associated privilege level. You can use dynamic roles, which are
predefined roles that provide default privilege levels. Or, you can create custom firewall administrator roles
or Panorama administrator roles and assign one of the following CLI privilege levels to each role:
You must follow the Best Practices for Securing Admin Access to ensure that you are
securing access to your management network in a way that will prevent successful attacks.
superuser Has full access to the Palo Alto Networks device (firewall or Panorama) and
can define new administrator accounts and virtual systems. You must have
superuser privileges to create an administrative user with superuser privileges.
vsysadmin Has access to selected virtual systems (vsys) on the firewall to create and
manage specific aspects of virtual systems. A virtual system administrator
doesn’t have access to network interfaces, VLANs, virtual wires, virtual routers,
IPSec tunnels, GRE tunnels, DHCP, DNS Proxy, QoS, LLDP, or network
profiles.
vsysreader Has read-only access to selected virtual systems on the firewall and specific
aspects of virtual systems. A virtual system administrator with read-only
access doesn’t have access to network interfaces, VLANs, virtual wires, virtual
routers, IPSec tunnels, GRE tunnels, DHCP, DNS Proxy, QoS, LLDP, or network
profiles.
deviceadmin Has full access to all firewall settings except for defining new accounts or
virtual systems.
devicereader Has read-only access to all firewall settings except password profiles (no
access) and administrator accounts (only the logged in account is visible).
panorama-admin Has full access to Panorama except for the following actions:
• Create, modify, or delete Panorama or device administrators and roles.
• Export, validate, revert, save, load, or import a configuration.
username@hostname> configure
Entering configuration mode
[edit]
username@hostname#
Notice that the command prompt changes from a > to a #, indicating that you successfully changed
modes.
• To switch from configuration mode to operational mode, use either 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,
for example:
username@hostname>
configure
Entering configuration mode
[edit]
username@hostname#
show network interface ethernet
ethernet {
ethernet1/1 {
virtual-wire;
}
ethernet1/2 {
virtual-wire;
}
ethernet1/3 {
layer2 {
units {
ethernet1/3.1;
}
}
}
ethernet1/4;
}
[edit]
username@hostname#
You can also view a complete listing of all Operational Commands and Configure Commands
or view the CLI Changes in PAN-OS 10.0.
For example, suppose you want to configure certificate authentication and you want the Palo Alto
Networks device to get the username from a field in the certificate, but you don’t know the command. In
this case you might use find command keyword to search for commands that contain username in the
command syntax.
From the resulting lists of commands, you can identify that the command you need is:
If you’re not sure exactly what to enter in the command line, you can then Get Help on Command Syntax.
Notice that the question mark doesn’t appear in the command line when you type it, but a list of the
available commands appears. You can continue getting syntactical help all through the hierarchy:
Use the Tab key in the middle of entering a command and the command will automatically
complete, provided there are no other commands that match the letters you have typed
thus far. For example, if you type set dev and then press Tab, the CLI will recognize that
the command you are entering is deviceconfig and automatically finish populating the
command line.
Symbol Description
+ Indicates that the option has an associated value that you must enter.
For example, when setting up a high availability configuration, notice that the
+ enabled notation indicates that you must supply a value for this option:
| Allows you to filter command output. You can either specify a match value,
which will only show command output that matches the value you specify,
or you can specify an except value, which will only show command output
except for the value you specify.
For example, use the | match option to display only the app-version in the
output of the show system info command:
Similarly, to show all users in your group lists who are not part of your
organization, you should show the user group list, but exclude the
organizational unit (ou) for your organization. Notice that, although there are
a total of 4555 user-to-group mappings, with the | except filter you can
easily see the small list of users who are part of external groups:
If you want to set the CLI timeout value to a value different from the global management
idle-timeout value, use the set cli timeout command in operational mode.
For example, in the default setting the config-output-format looks like this:
Changing the setting to set results in output that looks like this:
Changing the setting to xml results in output that looks like this:
When in scripting-mode, you cannot use Tab to complete commands or use ? to get
help on command syntax. When you are done pasting commands, switch back to regular
mode using the set cli scripting-mode off command.
29
30 PAN-OS CLI QUICK START | Use the CLI
© 2021 Palo Alto Networks, Inc.
View Settings and Statistics
Use show commands to view configuration settings and statistics about the performance of the firewall or
Panorama and about the traffic and threats identified on the firewall. You can use show commands in both
Operational and Configure mode. For example, the show system info command shows information
about the device itself:
hostname: PA-850
ip-address: 10.10.10.23
public-ip-address: unknown
netmask: 255.255.255.0
default-gateway: 10.10.10.1
ip-assignment: static
ipv6-address: unknown
ipv6-link-local-address: fe80::d6f4:beff:febe:ba00/64
ipv6-default-gateway:
mac-address: d4:f4:be:be:ba:00
time: Tue Feb 12 08:40:09 2019
uptime: 6 days, 11:51:18
family: 800
model: PA-850
serial: 011901000300
cloud-mode: non-cloud
sw-version: 9.0.0-c300
global-protect-client-package-version: 0.0.0
app-version: 8114-5254
app-release-date: 2019/01/16 15:14:11 PST
av-version: 2860-3370
av-release-date: 2019/01/16 10:05:59 PST
threat-version: 8114-5254
threat-release-date: 2019/01/16 15:14:11 PST
wf-private-version: 0
wf-private-release-date: unknown
url-db: paloaltonetworks
wildfire-version: 314895-317564
wildfire-release-date: 2019/01/16 18:20:09 PST
url-filtering-version: 20190201.20201
global-protect-datafile-version: unknown
global-protect-datafile-release-date: unknown
global-protect-clientless-vpn-version: 0
global-protect-clientless-vpn-release-date:
logdb-version: 9.0.10
platform-family: 800
vpn-disable-mode: off
multi-vsys: off
operational-mode: normal
admin@PA-3220>
The show session info command shows details about the sessions running through the Palo Alto
Networks device.
--------------------------------------------------------------------------------
Number of sessions supported: 196606
Number of allocated sessions: 0
Number of active TCP sessions: 0
Number of active UDP sessions: 0
Number of active ICMP sessions: 0
Number of active GTPc sessions: 0
Number of active GTPu sessions: 0
Number of pending GTPu sessions: 0
Number of active BCAST sessions: 0
Number of active MCAST sessions: 0
Number of active predict sessions: 0
Number of active SCTP sessions: 0
Number of active SCTP associations: 0
Session table utilization: 0%
Number of sessions created since bootup: 5044051
Packet rate: 0/s
Throughput: 0 kbps
New connection establish rate: 0 cps
--------------------------------------------------------------------------------
Session timeout
TCP default timeout: 3600 secs
TCP session timeout before SYN-ACK received: 5 secs
TCP session timeout before 3-way handshaking: 10 secs
TCP half-closed session timeout: 120 secs
TCP session timeout in TIME_WAIT: 15 secs
TCP session delayed ack timeout: 250 millisecs
TCP session timeout for unverified RST: 30 secs
UDP default timeout: 30 secs
ICMP default timeout: 6 secs
SCTP default timeout: 3600 secs
SCTP timeout before INIT-ACK received: 5 secs
SCTP timeout before COOKIE received: 60 secs
SCTP timeout before SHUTDOWN received: 30 secs
other IP default timeout: 30 secs
Captive Portal session timeout: 30 secs
Session timeout in discard state:
TCP: 90 secs, UDP: 60 secs, SCTP: 60 secs, other IP protocols: 60
secs
--------------------------------------------------------------------------------
Session accelerated aging: True
Accelerated aging threshold: 80% of utilization
Scaling factor: 2 X
--------------------------------------------------------------------------------
Session setup
TCP - reject non-SYN first packet: True
Hardware session offloading: True
Hardware UDP session offloading: True
IPv6 firewalling: True
Strict TCP/IP checksum: True
Strict TCP RST sequence: True
Reject TCP small initial window: False
ICMP Unreachable Packet Rate: 200 pps
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
Session behavior when resource limit is reached: drop
--------------------------------------------------------------------------------
Pcap token bucket rate : 10485760
--------------------------------------------------------------------------------
Max pending queued mcast packets per session : 0
--------------------------------------------------------------------------------
• To change the value of a setting, use a set command. For example, to configure an NTP server,
you would enter the complete hierarchy to the NTP server setting followed by the value you
want to set:
To target a command to a specific virtual system (vsys), enter the following operational
mode command: set system setting target-vsys <vsys-name>. To go back
to issuing commands that apply to the firewall instead of the targeted vsys, use set
system target-vsys none.
[edit]
admin@PA-3060# edit deviceconfig system ntp-servers
[edit deviceconfig system ntp-servers]
admin@PA-3060#
Notice that when you enter the command, your new location in the command hierarchy is displayed.
You can now use the set command to configure the NTP server settings without entering the entire
command hierarchy:
Use the up command to move up a level in the command hierarchy. Use the top
command to move back to the top of the command hierarchy.
• To delete an existing configuration setting, use a delete command. For example, to delete the
secondary NTP server address, you would enter the following command:
When deleting configuration settings or objects using the CLI, the device does not check
for dependencies like it does in the web interface. Therefore, when you use delete
Notice that because the object you are matching on has a space in it, you must enclose it
in quotation marks.
To see details (such as queue positions or Job-IDs) about commits that are pending, in
progress, completed, or failed, run the operational command show jobs all. To see the
messages and description for a particular commit, run show jobs id <job-id>.
admin@PA-3060> configure
admin@PA-3060# validate full
Validate job enqueued with jobid 3041
3041
2. View the validation results using the job ID that was displayed when you entered the validate
command. Verify that the job finished (FIN) and that the configuration is valid as shown in the
following example:
[edit]
admin@PA-3060# exit
Exiting configuration mode
admin@PA-3060> show jobs id 3041
STEP 2 | After successfully validating the configuration, save it to the running configuration by
performing a commit of all or a portion of the configuration:
• Commit the entire configuration:
admin@PA-3060> configure
admin@PA-3060# commit
• Commit part of the configuration on a firewall with multiple virtual systems:
When doing a partial commit from the CLI, you must specify what part of the configuration to
exclude from the commit. You can also filter the configuration changes by administrator. For
example, the following command commits only the changes that an administrator with the username
jsmith made to the vsys1 configuration and to shared objects:
For example, if you made a change in the Security policy only, you might want to commit just the
policy and objects portion of the configuration as follows:
If the commit takes a long time, you can press Ctrl+C to access the command line
while the commit continues as a background process.
STEP 1 | (Vsys-specific authentication profiles only) Specify which virtual system contains the
authentication profile you want to test. This is only necessary if you are testing an
authentication profile that is specific to a single virtual system (that is, you do not need to do
this if the authentication profile is shared).
For example, to test an authentication profile in vsys2 you would enter the following command:
The set system setting target-vsys command is not persistent across sessions.
You will be prompted for the password associated with the user account.
Profile names are case-sensitive. Also, if the authentication profile has a username
modifier defined, you must enter it with the username. For example, if the username
modifier is %USERINPUT%@%USERDOMAIN%, for a user named bzobrist in domain
acme.com, you would need to enter [email protected] as the username.
STEP 1 | On the device from which you want to copy configuration commands, set the CLI output mode
to set:
STEP 2 | Show the part of the configuration you want to copy. For example, to copy the SNMP
configuration you would enter the following command:
When pasting commands into the command line, make sure you are entering them in
the proper order to avoid errors. Sometimes commands shown in the CLI are not the
order in which they must be configured on the device (for example, if you are pasting
a configuration from a firewall into Panorama). If you see errors, check whether the
command that generated the error is dependent on a later command. In these cases,
you can usually just reenter the command. Also make sure you are pasting sections of a
configuration in a logical order. For example, you should not copy security policy rules if
you have not yet configured the objects the rules rely on, such as zones, security profiles,
or address groups.
STEP 3 | Copy the commands to a text editor such as Notepad and edit the settings as desired.
STEP 4 | On the second device, paste the commands into the command line.
There is a limit to the amount of text that can be copied into the SSH buffer
(approximately 20 lines). If you cut-and-paste a large block of text into the CLI, examine
the output of the lines you pasted. If you see lines that are truncated or generate errors,
you may have to re-paste a smaller section of text, or switch to scripting mode using
the set cli scripting-mode on operational mode command, which increases the
buffer significantly.
If you are managing more than two or three firewalls, consider using Panorama for central
management and monitoring of your firewalls.
To specify what part of the configuration to load, you must find the xpath location, which specifies the XML
node in the configuration file you are loading from and the node in the local candidate configuration you are
loading to.
The format of the command is:
Use the information in the following topics to determine the appropriate Xpath location formats and use
them to load a configuration object from one configuration to another:
• Xpath Location Formats Determined by Device Configuration
• Load a Partial Configuration into Another Configuration Using Xpath Values
Multi-vsys from-xpath
Firewall
devices/entry[@name='localhost.localdomain']/vsys/
entry[@name='vsys-ID']/<object>
to-xpath
/config/devices/entry[@name='localhost.localdomain']/vsys/
entry[@name='vsys-ID']/<object>
Single-vsys from-xpath
Firewall
devices/entry[@name='localhost.localdomain']/vsys/
entry[@name='vsys1']/<object>
to-xpath
/config/devices/entry[@name='localhost.localdomain']/vsys/
entry[@name='vsys1']/<object>
Panorama from-xpath
Shared
Object shared/<object>
to-xpath
/config/shared/<object>
Panorama from-xpath
Device
Group devices/entry[@name='localhost.localdomain']/device-group/
Object entry[@name='device-group-name']/ <object>
to-xpath
/config/devices/entry[@name='localhost.localdomain']/device-
group/entry[@name='device-group- name']/<object>
You can also find the xpath from the CLI debug mode (use the operational mode
command debug mode on to enable this), and then enter the configuration mode
show command that shows the object you are interested in copying. For example, to
see the xpath for the application object configuration in vsys1, you would enter the
show vsys vsys1 application command. Look for the section of the output that
begins with <requestcmd="get" obj=". This signals the beginning of the xpath. In
the following example, the highlighted section is the xpath for the application objects in
vsys1:
STEP 2 | Use the load config partial command to copy sections of the configuration you just
imported. For example, you would use the following command to load the application filters
you configured on fw1 from a saved configuration file, fw1-config.xml, you imported from fw1
(a single-vsys firewall) to vsys3 on fw2. Notice that even though fw1 does not have multiple
virtual system support, the xpath still points to the vsys1 (the default vsys ID on single-vsys
firewalls):
The quotation marks around the hostname and the vsys name (if applicable) must be
neutral. The command will fail if there are opened or closed quotation marks.
Because the file for the entire log database is too large for an export or import to be practical
on the following models, they do not support the scp export logdb or scp import
logdb commands: Panorama virtual appliance running Panorama 6.0 or later releases,
Panorama M-Series appliances (all releases), and PA-7000 Series firewall (all releases).
• Export a Saved Configuration from One Firewall and Import it into Another
• Export and Import a Complete Log Database (logdb)
STEP 1 | On the first firewall, save the current configuration to a named configuration snapshot using
the save config to <filename> command in configuration mode. For example:
STEP 2 | Export the named configuration snapshot and log database to an SCP-enabled server using the
scp export command in operational mode. When prompted, enter the password for your SCP
server account.
For an SCP server running on Windows, the destination folder/filename path for both the export and
import commands requires a drive letter followed by a colon. For example:
STEP 3 | Log in to the firewall to which you want to copy the configuration and logs, and then import
the configuration snapshot and log database. When prompted, enter the password for your
SCP server account.
For an SCP server running on Windows, the destination folder/filename path for both the export and
import commands requires a drive letter followed by a colon. For example:
STEP 2 | Log in to the firewall on which to import a log database, and then enter the import command.
When prompted, enter the password for your SCP server account.
MGT interface
# set deviceconfig system ip-address
admin password
# set mgt-config users admin password
DNS
# set deviceconfig system dns-setting servers
NTP
# set deviceconfig system ntp-servers
Interfaces
# set network interface
System settings
# set deviceconfig system
Zones
# set zone <name>
# set vsys <name> zone <name>
Security Profiles
# set profiles
HIP Objects/Profiles # set vsys <name> profiles
URL Filtering Profiles # set shared profiles
WildFire Analysis
Profiles
Server Profiles
# set server-profile
# set vsys <name> server-profile
# set shared server-profile
Authentication
Profiles # set authentication-profile
# set vsys <name> authentication-profile
# set shared authentication-profile
Certificate Profiles
# set certificate-profile
# set vsys <name> certificate-profile
# set shared certificate-profile
Policy
# set rulebase
# set vsys vsys1 rulebase
Log Quotas
# set deviceconfig setting management quota-settings
User-ID
# set user-id-agent
# set vsys <name> user-id-agent
# set user-id-collector
# set vsys <name> user-id-collector
HA
# set deviceconfig high-availability
AutoFocus Settings
# set deviceconfig setting autofocus
WildFire Settings
# set deviceconfig setting wildfire
Panorama
# set deviceconfig system panorama-server
Restart
> request restart system
51
52 PAN-OS CLI QUICK START | CLI Cheat Sheets
© 2021 Palo Alto Networks, Inc.
CLI Cheat Sheet: Device Management
Use the following table to quickly locate commands for common device management tasks:
To see more comprehensive logging information enable debug mode on the agent using
the debug user-id log-ip-user-mapping yes command. When you are done
troubleshooting, disable debug mode using debug user-id log-ip-user-mapping
no.
View all User-ID agents configured to send user mappings to the Palo Alto Networks device:
• To see all configured Windows-based agents:
View how many log messages came in from syslog senders and how many entries the User-ID agent
successfully mapped:
View the configuration of a User-ID agent from the Palo Alto Networks device:
Show user mappings filtered by a username string (if the string includes the domain name, use two
backslashes before the username):
Show usernames:
View the most recent addresses learned from a particular User-ID agent:
> show log userid datasourcename equal <agent-name> direction equal backward
For example:
NAT
IPSec
BFD
PVST+
Troubleshooting
Example output:
1 10 30 1587
To view system information about a Panorama virtual appliance or M-Series appliance (for
example, job history, system resources, system health, or logged-in administrators), see CLI
Cheat Sheet: Device Management.
A Dedicated Log Collector mode has no web interface for administrative access, only a
command line interface (CLI).
M-Series Appliance Mode of Operation (Panorama, Log Collector, or PAN-DB Private Cloud Mode)
Switching the mode reboots the M-Series appliance, deletes any existing log data, and
deletes all configurations except the management access settings.
#
show device-group
branch-offices
set device-group
branch-offices devices
set device-group
branch-offices pre-rulebase
...
Log Collection
69
70 PAN-OS CLI QUICK START | CLI Changes in PAN-OS 10.0
© 2021 Palo Alto Networks, Inc.
Load Commands Changed in PAN-OS 10.0
We modified the following commands in the 10.0 release to include the skip-validate command.
set network logical-router <name> vrf <name> bgp peer-group <name> peer
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> enable <yes|no>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> peer-as <1-4294967295>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> enable-sender-side-loop-detection <yes|no>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> address-family
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> address-family inherit <yes|no>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> address-family ipv4
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> address-family ipv4 unicast <value>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> address-family ipv6
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> address-family ipv6 unicast <value>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> local-address
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> local-address interface <value>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> local-address ip <value>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> peer-address
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> peer-address ip <value>|<ip/netmask>|<validate>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> connection-options
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> connection-options timers <value>|<inherit>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> connection-options multihop <0-255>|<inherit>
set network logical-router <name> vrf <name> bgp peer-group <name> peer
<name> connection-options authentication <value>|<inherit>
set shared admin-role <name> role device webui monitor logs decryption
<enable|disable>
set shared admin-role <name> role device webui objects devices <enable|read-
only|disable>
set shared admin-role <name> role device webui objects sdwan sdwan-saas-
quality-profile <enable|read-only|disable>
set shared admin-role <name> role device webui objects sdwan sdwan-error-
correction-profile <enable|read-only|disable>
set shared admin-role <name> role device webui network routing
set shared admin-role <name> role device webui network routing logical-
routers <enable|read-only|disable>
set shared admin-role <name> role device webui network routing routing-
profiles
set shared admin-role <name> role device webui network routing routing-
profiles bgp <enable|read-only|disable>
set shared admin-role <name> role device webui device data-redistribution
<enable|read-only|disable>
set shared admin-role <name> role device webui device device-quarantine
<enable|read-only|disable>
set shared admin-role <name> role device webui device certificate-management
ssh-service-profile <enable|read-only|disable>
set shared admin-role <name> role device webui device policy-recommendation
<enable|read-only|disable>
set shared admin-role <name> role vsys webui monitor logs decryption
<enable|disable>
set shared admin-role <name> role vsys webui objects devices <enable|read-
only|disable>
set shared admin-role <name> role vsys webui objects sdwan sdwan-saas-
quality-profile <enable|read-only|disable>
set shared admin-role <name> role vsys webui objects sdwan sdwan-error-
correction-profile <enable|read-only|disable>
set shared admin-role <name> role vsys webui device setup telemetry <read-
only|disable>
set shared admin-role <name> role vsys webui device data-redistribution
<enable|read-only|disable>
set shared admin-role <name> role vsys webui device device-quarantine
<enable|read-only|disable>
set shared admin-role <name> role vsys webui device certificate-management
ssh-service-profile <enable|read-only|disable>
set shared admin-role <name> role vsys webui device policy-recommendation
<enable|read-only|disable>
set vsys <name> reports <name> type desum values [ <values1> <values2>... ]
set vsys <name> reports <name> type desum labels [ <labels1> <labels2>... ]
set vsys <name> reports <name> type data values [ <values1> <values2>... ]
Added infinite and disable options also changed flap-max from 0-16 to 1-16.
Added vsys|gateway|selection_type|response_time|priority|attempted_gateways
options.
set shared log-settings iptag match-list <name> actions <name> type tagging
target <source-address|destination-address|xff-address|user>
set vsys log-settings profiles <name> match-list <name> actions <name> type
target <source-address|destination-address|xff-address|user>
Replaced set deviceconfig system ssh ciphers, kex, mac mgmt with set deviceconfig
system ssh profiles mgmt-profiles and set deviceconfig system ssh mgmt
Replaced show deviceconfig system cipher mgmt with show deviceconfig system ssh mgmt.