Focus

PAN-OS® and Panorama™ API Guide

XPath Node Selection

Table of Contents

XPath Node Selection

There are various ways to specify the XPath for an XML node in an API request. The simplest is to use the location path of the resource. For example, to select all users within your management configuration, use the following path:

/config/mgt-config/users

The above path specifies the following XML node that includes all users:

<users>
  <entry name="admin">
    <permissions>
      <role-based>
        <superuser>yes</superuser>
      </role-based>
    </permissions>
  </entry>
  <entry name="guest">
    <permissions>
      <role-based>
        <custom>
          <profile>NewUser</profile>
        </custom>
      </role-based>
    </permissions>
  </entry>
</users>

Targeting multiple nodes in an XPath using nested elements results in a successful command, but will not update all of the nodes. To update each node, send the configuration to each node using multiple successive calls. For example:

/entry[@name='TEST_IKE_PAN']/protocol/ikev1/dpd&element=<enable>yes</enable></dpd></ikev1><version>ikev2-preferred</version></protocol>&/ikev2&element=<ike-crypto-profile>default</ike-crypto-profile></ikev2>&/peer-address&element=<ip>1.2.3.4</ip>

To successfully update each node, target each node individually, for example:

entry[@name='TEST_IKE_PAN']/peer-address&element=<ip>1.2.3.4</ip>

Another method for selecting the XPath for an XML node is to select the specific node, such as the superuser or NewUser node within the node shown above. Use XPath syntax similar to the following to drill-down and select a specific node:

XML Node	XPath Syntax
	/config/mgt-config/users/entry/permissions/role-based/superuser[text()='yes']
	/config/mgt-config/users/entry/permissions/role-based/custom/profile[text()='NewUser']

XML and XPath

Get Started with the PAN-OS XML API