Setting up API Access to Palo Alto Networks VM-Series

Complete the following steps to enable Palo Alto Networks API programming.

Enabling Ping

Make sure the Palo Alto Networks management interface has ping enabled and the instance’s security group has ICMP policy open to the Aviatrix Controller’s public IP address.

In the Palo Alto VM-Series console:

  1. Click Device.

  2. Click Interfaces.

  3. Click Management.

  4. Make sure the setup matches the following screenshot.

pan_ping

Creating API Administrator Role Profile

  1. To create a new role profile, go to Device > Admin Roles > +Add.

  2. In the Name field, enter Aviatrix-API-Role.

  3. Click the XML/API tab.

  4. Click Report, Configuration, Operation Requests and Commit.

  5. Click OK and then commit.

    pan_role_profile

Adding an Administrator for API

To add an administrator for Role-Based access, in the VM-Series Console, go to Device > Administrators > +Add, as shown below. Use the profile created in the previous step. Click OK and then commit.

pan_admin

Managing VM-Series Directly

Login to the Aviatrix Controller and navigate to Firewall Network > Vendor Integration > Firewall. Configure the following parameters and click Save.

Setting Value

FireNet VPC/VNet ID

The FireNet VPC/VNet ID for the Firewall Network deployment.

Firewall instance ID

The firewall virtual machine (EC2/GCE) instance ID. Aviatrix Controller monitors the health of this instance and determines fail over when it becomes unreachable.

Firewall Name (Optional)

A name to remember.

Firewall Vendor Type

Select PAN

Firewall Login User Name

firewall login name for API calls from the Controller. For example, admin-api.

Firewall Login Password

firewall login password for API calls.

Firewall Management IP Address

The public IP address of the firewall management interface for API calls from the Aviatrix Controller

Firewall Virtual Router name (Optional)

Specify the firewall virtual Router name you wish the Controller to program. If left unspecified, the Controller programs the firewall’s default router.

The Aviatrix Controller only supports one virtual router. If the Firewall Virtual Router name is not specified, the controller takes the first virtual router in the list.

Managing VM-Series by Panorama

If Panorama is used to manage your Palo Alto VM-Series firewalls, any dynamic route updates initiated by Aviatrix CoPilot are sent to Panorama. CoPilot does not check the health of Panorama; it only checks the health of the VM-Series instances.

CoPilot communicates with Palo Alto Panorama to its private IP address, if Panorama is reachable via private IP.

If you are using two cross-sites, the primary IP address of Panorama can be determined via the Vendor Integration function.

Before you integrate Panorama with CoPilot, you need to first launch and configure Panorama.

  • Panorama needs to be configured separately for the primary and HA (backup) FireNet Gateways.

  • Panorama can be configured even when there is no VM-Series associated with a FireNet Gateway. However, in such cases, the egress subnet is not decided, which means the egress route cannot be added. Once the first VM-Series instance is launched and is in sync with Panorama, the egress route is automatically added.

  • If any VM-Series for a FireNet has already been added, you must remove that configuration before configuring Panorama. See the migration instructions in the next section.

  • After Panorama is set up, any additional VM-Series associated with same gateway will be controlled by Panorama and no further configuration on the VM-Series is needed.

  • When Panorama is configured, the associated will show the vendor as "Palo Alto Panorama." and password to access firewall and retrieve route information.

  • The Aviatrix Controller only supports one virtual router. If the Router name is not specified, the Controller takes the first virtual router in the list.

Launching Panorama

  1. Launch Panorama from the AWS portal and SSH in to set the UI password, which is the same as the PAN firewall.

  2. Change the Panorama management interface security group to allow port 3978. This is the port used by Panorama and the firewall to exchange information.

  3. Install a license in Panorama. Without the correct license, Panorama will not work.

Upgrading Panorama

Panorama must be on the same or higher software version as its managed firewalls.

If your version of Panorama is lower than version 9.0.6 or 9.1.2, you must upgrade.

  1. Go to Panorama > Dynamic Updates, click Check Now, and select the latest version of Panorama in Applications and Threats.

  2. Download and install.

  3. Navigate to Panorama > Software, select the desired version, download and install. After installation, Panorama will reboot. This will take a few minutes.

Creating Templates and Template Stack

In Panorama, templates and template stacks are used to configure Network properties, such as interfaces, zones, and route tables. This is the one that needs monitoring and updates via the API.

  1. Create Template: You should create a template for each firewall group: One for the FireNet primary Gateway and one for the FireNet backup Gateway.

  2. Configure Template: Add interfaces (ethernet1/1, ethernet1/2), zones (LAN, WAN), and Virtual Routers (route tables). Do not name the route table as "default" since this may conflict with the firewall’s default route table. Please refer to step 7 and 10 of the Example Config for Palo Alto Network with VM-Series.

  3. Create Template Stack: A Template stack is a bundle to bind templates with managed devices. When creating, select Template(s) and Devices. Create one template stack for the primary FireNet Gateway, and another for the backup FireNet Gateway. Make note of the template stack name. Commit and push.

Creating Device Group

A Device Group is used to manage all the firewall policies.

  1. Navigate to Panorama > Device Groups.

  2. Click Add to create a new device group for both FireNet gateways.

  3. Add managed VMs to the device group. Make note of the device group name (for example, "west2-firenet-primary"). You may create two device groups if you want to edit each FireNet gateway separately.

  4. (optional if internet traffic is needed) Add an "Outbound" policy to the newly created device group.

  5. (optional) If you plan to deploy Egress inspection, add source-nat and security outbound rule policies.

  6. Commit and push the changes.

After the above steps, once VM-Series instances are added to Panorama, all configuration should be done through the Panorama console.

Creating Admin Role and Admin User Role

This is the same as for individually managed VM-Series. Create an admin role with XML API permission and create an admin user with the admin role.

  1. After you have set up and configured your Panorama, go to Security > FireNet.

  2. Pick a FireNet to which to add the Panorama firewall manager.

  3. Click the link 40 icon and select Vendor Integration.

  4. Follow these steps.

Migrating from Individual VM to Panorama

Assuming you have existing individually managed VM-Series in CoPilot and have prepared your Panorama, follow the instructions below to migrate individual VMs to Panorama.

Removing the Firewall Integration as PAN

If any firewall for a FireNet is already integrated with PAN as the Vendor type, you need to remove that configuration.

  1. Navigate to Security > Firewall and select a PAN VM-Series firewall.

  2. Click the link 40 icon and remove it from the FireNet.

Removing Firewall Configuration

If this is a new VM, skip this step.

From your firewall console, remove the interfaces, zone, virtual router, policies, api admin role and api administrator.

Adding Firewall to Panorama

Refer to How to Add a Locally Managed Firewall to Panorama Management.

  1. Add the firewall to the Panorama-managed devices list.

    1. Log into Panorama, select Panorama > Managed Devices and click Add.

    2. Enter the serial number of the firewall and click OK.

    3. Commit. For the Commit Type, select Panorama and click Commit again.

  2. Set up a connection from the firewall to Panorama.

    1. Log in to the firewall, select Device > Setup, and edit the Panorama Settings.

    2. In the Panorama Servers fields, enter the IP addresses of the Panorama management server.

    3. Click OK and Commit.

  3. Make any necessary configuration changes and commit your changes to the VMs.

    1. Click Commit and for the Commit Type select Device Group.

    2. Select Merge with Device Candidate Config, mark the Include Device and Network Templates checkbox, and click Commit.

  4. Go back to Panorama > Managed Devices > Summary and mark the checkbox for the device which should show "Connected."

Port 3978 also needs to be allowed on the firewall side.

Adding the Device into the Desired Template Stack and Device Group

  1. Go to Panorama > Template, select the desired template stack, and check the firewall from the device list.

  2. Go to Panorama > Device Group, select the desired group and check the firewall from the device list.

  3. Commit and push.

Integrating Panorama with CoPilot

Complete the vendor integration steps here. After this step, the Panorama and PAN firewalls are attached to the Controller.

API Calls

The integrated functions by the Controller are the following:

  • The Controller monitors the health of Palo Alto Network software by using the VM-series API and performs switch over based on the API return status.

  • The Controller dynamically programs Palo Alto Network route tables for any new propagated new routes discovered both from new Spoke VPC/VNets and new on-premise routes.

Examples of Palo Alto Networks API used:

  1. get key:

https://54.149.55.193/api/?password=password&type=keygen&user=apiadmin

  1. get route tables:

https://54.149.55.193/api/?type=config&xpath=/config/devices/entry[@name='localhost.localdomain']/network/virtual-router/entry[@name='default']&key=LUFRPT1YQk1SUlpYT2xIT3dqMUFmMlBEaVgxbUxwTmc9RFRlWncrbURXZVpXZUUyMFE3V3ZWVXlaSlFvdkluT2F4dzMzWUZpMGtZaz0=&action=get

  1. show interfaces:

https://54.149.55.193/api/?key=LUFRPT1BbkNIbXJZNlVBOVdRMXNMSUNVRis1VWRHaTA9RFRlWncrbURXZVpXZUUyMFE3V3ZWU2ZEZzdCNW8yUEpwU3Q1NXEzeDBnST0=&type=op&cmd=<show><interface>ethernet1/2</interface></show>

  1. add route:

https://13.58.10.51/api/?type=config&xpath=/config/devices/entry[@name='localhost.localdomain']/network/virtual-router/entry[@name='default']/routing-table/ip/static-route/entry[@name='test2']&key=LUFRPT1BbkNIbXJZNlVBOVdRMXNMSUNVRis1VWRHaTA9RFRlWncrbURXZVpXZUUyMFE3V3ZWU2ZEZzdCNW8yUEpwU3Q1NXEzeDBnST0=&action=set&element=<nexthop><ip-address>10.201.1.1</ip-address></nexthop><bfd><profile>None</profile></bfd><path-monitor><enable>no</enable><failure-condition>any</failure-condition><hold-time>2</hold-time></path-monitor><metric>10</metric><destination>10.40.0.0/24</destination><route-table><unicast/></route-table>

  1. delete route:

https://13.58.10.51/api/?type=config&xpath=/config/devices/entry[@name='localhost.localdomain']/network/virtual-router/entry[@name='default']/routing-table/ip/static-route/entry[@name='test2']&key=LUFRPT1BbkNIbXJZNlVBOVdRMXNMSUNVRis1VWRHaTA9RFRlWncrbURXZVpXZUUyMFE3V3ZWU2ZEZzdCNW8yUEpwU3Q1NXEzeDBnST0=&action=delete

  1. commit

https://13.58.10.51/api/?type=commit&key=LUFRPT1BbkNIbXJZNlVBOVdRMXNMSUNVRis1VWRHaTA9RFRlWncrbURXZVpXZUUyMFE3V3ZWU2ZEZzdCNW8yUEpwU3Q1NXEzeDBnST0=&cmd=<commit></commit>