Focus

PAN-OS® and Panorama™ API Usage Guide

Commit

Table of Contents

Commit

Replace the body element in the cmd parameter with the XML element for the corresponding commit operation.

Use the API Browser to find different options available for use with force and partial commits.

Use one of the following requests to commit a configuration:

Commit— Commit candidate changes to the firewall.


						ttps://<firewall>/api/?key=apikey&type=commit&cmd=<commit></commit>

Force Commit—


						ttps://<firewall>/api/?key=apikey&type=commit&cmd=<commit><force></force></commit>

Partial commit while excluding shared objects and device and network configuration—


						ttps://<firewall>/api/?key=apikey&type=commit&action=partial&cmd=<commit><partial><device-and-network>excluded</device-and-network><shared-object>excluded</shared-object></partial></commit>

Partial commit admin-level changes— To commit admin-level changes on a firewall, include the administrator name in the request.


						ttps://<firewall>/api/?&type=commit&action=partial&cmd=<commit><partial><admin><member>$admin-name</member></admin></partial></commit>

Partial commit admin-level changes on a firewall or Panorama while excluding shared objects—Include the administrator name in the request. Replace the $admin-name Replace


						ttps://<firewall>/api/?&type=commit&action=partial&cmd=<commit><partial><device-and-network>excluded</device-and-network><shared-object>excluded</shared-object><admin><member>socadmin</member></admin></partial></commit>

Confirm that the XML response indicates that there were no changes to commit or that the changes are queued for commit:

No pending changes to commit:


								<response status="success" code="19">
									  <msg>There are no changes to commit.</msg></response>

Pending changes:


								<response status="success" code="19">
  <result>
    <msg>
      <line>Commit job enqueued with jobid 4</line>
    </msg>
    <job>4</job>
  </result>
</response>

Query the status of the job using the job ID:


						ttps://<firewall>/api/?key=apikey&type=op&cmd=<show><jobs><id>4</id></jobs></show>

Confirm that the XML response details state the Configuration was committed successfully:


						<response status="success">
  <result>
    <job>
      <tenq>2021/07/21 14:33:55</tenq>
      <tdeq>14:33:55</tdeq>
      <id>4</id>
      <user>admin</user>
      <type>Commit</type>
      <status>ACT</status>
      <queued>NO</queued>
      <stoppable>yes</stoppable>
      <result>PEND</result>
      <tfin/>
      <description/>
      <positionInQ>0</positionInQ>
      <progress>55</progress>
      <warnings>
        <line>Aggregate-ethernet interface ae1 has no member interfaces.</line>
      </warnings>
      <details/>
    </job>
  </result>
</response>

Commit Configuration (API)

Commit-All