Skip to main content
 

Tip

This article was accurate at the time of writing, but changes happen. If you find the instructions are outdated, leave a description in the comment field below and let us know!

Step 1: Enable console access

This procedure creates a user account for Expel that keeps the Expel activity separate from other activity on the Palo Alto console.

Note

The Expel Assembler needs access to the Palo Alto device or instance through port 443 (UI) and 443 (API) for on-premises onboardings.

For cloud instances, you need to allow Expel through the internet. Expel has 6 egress IP addresses. All requests to the API come from 1 of the 6 IP addresses:

  1. Log onto the Palo Alto console.

  2. On the console page, navigate to Device > Administrators.

  3. Click Add at the bottom left of the page.

    Screen Shot 2021-03-08 at 7.18.38 AM.png
  4. In Administrator dialog box, type expeluser for Name.

    Screen Shot 2021-03-08 at 7.19.14 AM.png
  5. Type a Password.

  6. For Administrator Type, select Dynamic.

  7. Select Superuser (read-only) from the list below Administrator Type.

  8. Verify that expeluser is created on the console page.

Step 2: Generate API credentials

This procedure creates an authentication token that allows the Expel Assembler to access the Palo Alto API.

Note

Security Assertion Markup Language (SAML) authenticated accounts on Palo Alto cannot generate API keys.

  1. In a new browser tab, open the following URL, replacing <hostname or IP address>, <username>, and <password> with the appropriate values for your Panorama console or the management interface of your Palo Alto Networks firewall: https://<hostname or ip address>/api/?type=keygen&user=<username>&password=<password>

    • <hostname or IP address> is your Palo Alto URL from your console page.

    • <username> is the username created in Step 1 (expeluser).

    • <password> is the password entered in Step 1.

  2. After the URL is complete, press Enter. Below is an example of a completed URL.

    Screen Shot 2021-03-08 at 7.19.46 AM.png
  3. On the next screen, the generated API key appears. Save it for later use.

    Screen Shot 2021-03-08 at 7.20.17 AM.png
  4. If you use Wildfire API, we also need a Wildfire API key in addition to the API key just created. Follow these instructions and create a Wildfire API key. Save it for later use.

Step 3: Configure the technology in Workbench

  1. In a new browser tab, log into Workbench (this link opens the Add Security Device screen directly).

  2. On the Add Security Device screen, fill in the blanks like this:

    Screen Shot 2021-03-08 at 7.21.46 AM.png
    • For Where is your device? select your installation type.

    • For On-prem installations, select your Assembler from the list.

    • For Server address type the hostname or IP address of the Palo Alto management interface. Device IP can be found in the Palo Alto console under Dashboard > General Information > MGT IP Address.

    • For Name and Location, use a name and location that are meaningful to you.

    • For API key type the API key generated in Step 2.

    • For PanOS version, OS version must be specified if OS version is <= 6.

    • For Wildfire API key type the Wildfire API key generated in Step 2.