List security rules containing a specific subnet

In this section we present a workflow example for filtering security rules containing a specific subnet in a PAN-OS configuration.

Below flowchart demo the workflow and the related API calls in each of the steps:

Step 1. Obtain the API Keys

Refer to Obtaining the API Keys section to obtain a valid API key stored in the hed variable.

Step 2. Start the Expedition Agent

Refer to Managing Expedition's Agent section to start the agent and be able to perform imports into a project.

Step 3. Add PAN-OS Device

Making a POST call to the Device route, we can create a device with a desired name. Notice that we attach the credentials hed in the CURL headers to present our credentials and verify we have permission to create a device.

API syntax for creating a new device :

Method	Route	Request Body Parameters
POST	`https://localhost/api/v1/device`	{"name": devicename, "serial": serialnumber,"hostname": panosip,"type": devicetype,"description": pandescription, }
Example	`https://localhost/api/v1/device`	{"name":"mypanorama", "serial":"123456789","hostname":"pan1","type":"vm-panorama""description":"Project for testing"}

info

The supported device "type" are below:

        "m100",
        "m500",
        "m600",
        "vm-panorama",
        "pa200",
        "pa220",
        "pa500",
        "pa800",
        "pa3000",
        "pa3200",
        "pa4000",
        "pa5000",
        "pa5200",
        "pa7000",
        "vm-series"

Python

print("*****Add a new PAN-OS device\n")
panosip = '1.1.1.1'
serialnumber = '123412'
devicetype = "pa220"
pandescription = 'test'
url = "https://" + ip + "/api/v1/device"
data = {
    "name": devicename,
    "serial": serialnumber,
    "hostname": panosip,
    "type": devicetype,
    "description": pandescription,
}
r = requests.post(url, data=data, verify=False, headers=hed)
response = r.json()
success = json.dumps(response["success"])
if success == "true":
    print("New device created successfully" + " \n")
    DeviceId = json.dumps(response['data']['id'])
    print("Your Device-ID is " + str(DeviceId) + " \n")
else:
    print("Unable to create the device")
print("*****Upload PAN-OS config into device*****\n")

Step 4. Upload PAN-OS config into device

After device has been created , the next step will be uploading your pan-os config to associate with the device.

API syntax for upload PAN-OS config into device :

Method	Route	Path Parameters
POST	"https://localhost/api/v1/device/{device_id}/upload_config"	"device_id": "device_id"
Example	"https://localhost/api/v1/device/23/upload_config"	23

Python

print("*****Upload PAN-OS config into device*****\n")
file = '/Users/user1/Downloads/panoramabase.xml'
panosconfig = open(file, "rb")
files = {"config": panosconfig}
url = 'https://' + ip + '/api/v1/device/{0}/upload_config'.format(int(DeviceId))
r = requests.post(url, files=files, verify=False, headers=hed)
response = r.json()
success = json.dumps(response["success"])
if success == "true":
    print("Pan-OS config uploaded to the device successfully\n")
else:
    result = json.dumps(response["messages"][0]["message"])
    print(result)

Step 5. Create an Expedition Project

In the large amount of automation cases, we will require having an Expedition project. Making a POST call to the project route, we can create a project with a desired name.

API syntax for creating a new project:

Method	EndPoint	Parameters
POST	`https://localhost/api/v1/project`	in url { "project":"project1", "description":"Project for testing" }
example	`https://localhost/api/v1/project`	{"project":"MyLittleProject", "description":"A migration project"}

Python

print("*****Create a new Expedition Project*****\n")
projectName = input("Please enter project name: (Needs to start with letters): ")
print(" \n")
data = {"name": projectName, "device_id[0]": DeviceId}
url="https://" + ip + "/api/v1/project"
r = requests.post(url,data=data, verify=False, headers=hed)
response = r.json()
success = json.dumps(response["success"])
if success == "true":
    print("New project created successfully" + " \n")
    projectId = json.dumps(response['data']['id'])
    print("Your project-ID is", str(projectId) + " \n")
print("\n")

Step 6. Import the PAN-OS configuration of your device to the project

This step will associate the device with project. The API response will contain a job ID , you can then use API call to check job status. Please refer to checking job status Checking Job Status section

API syntax for the step:

Method	EndPoint	Parameters
POST	`https://localhost/api/v1/project/project_id/import/device`	in url "project_id":"project_id" in_body {"device_id":"device_id" }
example	`https://localhost/api/v1/project/22/import/device`	{"device_id":"23""}

Python

print("*****Import the PAN-OS configuration of your device to the project\n")
url = "https://" + ip + "/api/v1/project/{0}/import/device".format(int(projectId))
print(url)
data = {"device_id": DeviceId}
r = requests.post(url, data=data, verify=False, headers=hed)
response = r.json()
jobId = json.dumps(response["data"]["job_id"])
jobFinished = False
print("CHECK configuration upload status...........")
r = requests.get(
    "https://" + ip + "/api/v1/job/" + jobId + "?complete=true",
    verify=False,
    headers=hed,
)
response = r.json()
jobState = json.dumps(response["data"]["state"])
percentage = float(jobState) * 100
print(
    "Import PAN-OS configuration from device to Project: "
    + str(round(percentage, 2))
    + "%\n"
)
# Wait until job is done
while jobState != "1":
    sleep(5)
    r = requests.get(
        "https://" + ip + "/api/v1/job/" + jobId + "?complete=true",
        verify=False,
        headers=hed,
    )
    response = r.json()
    jobState = json.dumps(response["data"]["state"])
    percentage = float(jobState) * 100
    print(
        "PAN-OS configuration has been imported to Project: "
        + str(round(percentage, 2))
        + "%\n"
    )
response = r.json()
statusmessage = json.dumps(response["data"]["task"][0]["statusMessage"])
print(statusmessage)

Step 7. Get Source ID of the config file

In this step, we will make a API call to get source_id of the config file that's been imported to the project. After this API call, you will parse the response that contains source_id. The source_id represent the pan-os config file that you would like to work on, and it will be used in the subsequent API calls.

API syntax for the step:

Method	Route	Parameters
GET	`https://localhost/api/v1/project/{project_id}/source`	in url "project_id":project_Id in_body {"device_id":device_Id}
example	`https://localhost/api/v1/project/22/source`	{"device_id": 23}

Python

print("Get Source_ID of the config file")
url = "https://" + ip + "/api/v1/project/" + projectId + "/source"
r = requests.get(url, data=data, verify=False, headers=hed)
response = r.json()
print(response)
source_id = json.dumps(response["data"]["source"][0]["id"])
print("PAN-OS config source_id is: " + source_id)

Step 8. Create combined filters for security rules contain specific subnet

In this step, we will create total 6 filters to filter all security rules that contain subnet 10.0. Please refer to the Expedition-API Filters section for details on filters.

1st Filter

In this specific example, we are going to create the first filter that filter address objects contain ip address "10.1" in the value. Sending the request body contains below data:

data = {
    "name":'Addressobject_with_specific_subnet',
    "reference":'Addressobject_with_specific_subnet',
    "description": 'addressobject_with_subnet_10.1.',
    "filter": "[address] ipaddress contains \"10.1\"",
    }

API syntax for the step:

Method	Route	Parameters
POST	`https://localhost/api/v1/project/{project_id}/tools/filter`	in url "project_id":project_Id in_body {"name":filter_name,"filter":filter}
example	`https://localhost/api/v1/project/22/tools/filter`	{"name": "all allowed rules", "filter" : "[address] ipaddress contains \"10.1\""}

Python

    print("Create filter to filter address objects contain "10.1"")
    url = "https://" + ip + "/api/v1/project/" + projectId + "/tools/filter"
    data = {
        "name":'Addressobject_with_specific_subnet',
        "reference":'Addressobject_with_specific_subnet',
        "description": 'addressobject_with_subnet_10.1.',
        "filter": "[address] ipaddress contains \"10.1\"",

    }
    r = requests.post(url, data=data, verify=False, headers=hed)
    response = r.json()
    print(response)
    global filterID
    filterID_1 = json.dumps(response["data"]["last_history_entry"]["filter_id"])
    print("your filter ID is " + filterID_1)

2nd Filter

In this specific example, we are going to create the 2nd filter that filter address group objects contain member match first filter.
Sending the request body contains below data:

data = {
    "name" :'Addressgroupobject_with_specific_subnet',
    "reference" :'Addressgroupobject_with_specific_subnet',
    "description" : 'addressgroupobject_with_subnet_10.1.',
    "filter" : "[address_group] member contains filter Addressobject_with_specific_subnet",
    }

Python

    print("Create filter to filter address-group with member contain first filter")
    url = "https://" + ip + "/api/v1/project/" + projectId + "/tools/filter"
    data = {
        "name" :'Addressgroupobject_with_specific_subnet',
        "reference" :'Addressgroupobject_with_specific_subnet',
        "description" : 'addressgroupobject_with_subnet_10.1.',
        "filter" : "[address_group] member contains filter Addressobject_with_specific_subnet",

    }
    r = requests.post(url, data=data, verify=False, headers=hed)
    response = r.json()
    print(response)
    global filterID
    filterID_2 = json.dumps(response["data"]["last_history_entry"]["filter_id"])
    print("your filter ID is " + filterID_2)

3rd Filter

In this specific example, we are going to create the 3rd filter that combine 1st and 2nd filter we created in the previous steps. Sending the request body contains below data:

data = {

    "name" : 'combinefilter1and2',
    "reference" : 'combinefilter1and2',
    "description" :  'address/addressgroupobject_with_subnet_10.1.',
    "filter" : "filter Addressobject_with_specific_subnet or filter Addressgroupobject_with_specific_subnet",

    }

When we combine two single filter , we will use syntax below:

filter filter_name1 or filter filter_name2

Example in this case will be: filter Addressobject_with_specific_subnet or filter Addressgroupobject_with_specific_subnet

Python

    print("Combine filter1 and filter 2\n")
    url = "https://" + ip + "/api/v1/project/" + projectId + "/tools/filter"
    data = {
        "name" := 'combinefilter1and2',
        "reference" : 'combinefilter1and2',
        "description" :  'address/addressgroupobject_with_subnet_10.1.',
        "filter" : "filter Addressobject_with_specific_subnet or filter Addressgroupobject_with_specific_subnet",

    }
    r = requests.post(url, data=data, verify=False, headers=hed)
    response = r.json()
    print(response)
    global filterID
    filterID_3 = json.dumps(response["data"]["last_history_entry"]["filter_id"])
    print("your filter ID is " + filterID_3)

4th Filter

We are going to create the 4th filter to filter any security rules contain source address match 3rd filter

Sending the request body contains below data:

data = {

    "name" :'securityrule_with_specific_source_subnet',
    "reference" :'securityrule_with_specific_source_subnet',
    "description" : 'securityrule_with_src_subnet_10.1',
    "filter" : "[security_rule] source_address contains filter combinefilter1and2 ",

    }

Python

    print("Create filter to filter security rules source match filter 3\n")
    url = "https://" + ip + "/api/v1/project/" + projectId + "/tools/filter"
    data = {
        "name" :'securityrule_with_specific_source_subnet',
        "reference" :'securityrule_with_specific_source_subnet',
        "description" : 'securityrule_with_src_subnet_10.1',
        "filter" : "[security_rule] source_address contains filter combinefilter1and2 ",

    }
    r = requests.post(url, data=data, verify=False, headers=hed)
    response = r.json()
    print(response)
    global filterID
    filterID_4 = json.dumps(response["data"]["last_history_entry"]["filter_id"])
    print("your filter ID is " + filterID_4)

5th Filter

We are going to create the 5th filter to filter any security rules contain destination address match 3rd filter Sending the request body contains below data:

data = {

    "name" :'securityrule_with_specific_dst_subnet',
    "reference" :'securityrule_with_specific_dst_subnet',
    "description" : 'securityrule_with_dst_subnet_10.1',
    "filter" :  "[security_rule] destination_address contains filter combinefilter1and2 ",

    }

Python

    print("Create filter to filter security rules destination match filter 3\n")
    url = "https://" + ip + "/api/v1/project/" + projectId + "/tools/filter"
    data = {

        "name" :'securityrule_with_specific_dst_subnet',
        "reference" :'securityrule_with_specific_dst_subnet',
        "description" : 'securityrule_with_dst_subnet_10.1',
        "filter" :  "[security_rule] destination_address contains filter combinefilter1and2 ",

    }
    r = requests.post(url, data=data, verify=False, headers=hed)
    response = r.json()
    print(response)
    global filterID
    filterID_5 = json.dumps(response["data"]["last_history_entry"]["filter_id"])
    print("your filter ID is " + filterID_5)

6th Filter

We are going to create our final filter to combine filter 4 & 5, which will filter all security rules contain either source address or destination address that contain 10.1. Sending the request body contains below data:

data = {

    "name" : 'Combinefilter4_5',
    "reference" : 'Combinefilter4_5',
    "description" : 'securityrule_with_source_or_destination_contain_subnet_10.1',
    "filter" :  "filter securityrule_with_specific_source_subnet or filter securityrule_with_specific_dst_subnet ",

    }

Python

    print("Create filter to filter security rules destination match filter 3\n")
    url = "https://" + ip + "/api/v1/project/" + projectId + "/tools/filter"
    data = {

        "name" : 'Combinefilter4_5',
        "reference" : 'Combinefilter4_5',
        "description" : 'securityrule_with_source_or_destination_contain_subnet_10.1',
        "filter" :  "filter securityrule_with_specific_source_subnet or filter securityrule_with_specific_dst_subnet ",

    }
    r = requests.post(url, data=data, verify=False, headers=hed)
    response = r.json()
    print(response)
    global filterID
    filterID_6 = json.dumps(response["data"]["last_history_entry"]["filter_id"])
    print("your filter ID is " + filterID_6)

Step 9. Execute the final filter

After create the final filter, we will execute the filter based on filter_Id ,in our example , filter_Id will be "6" in the request body, you will need to provide "source_id" obtained from the previous step as required parameter.

API syntax for the step:

Method	Route	Parameters
POST	`https://localhost/api/v1/project/{project_id}/tools/filter/{filter_id}/execute`	in url "project_id":project_Id, "filter_id":filter_Id in_body {"source_id": source_id of the PAN-OS config file}
example	`https://localhost/api/v1/project/22/tools/filter/6/execute`	{"source_id": "23564"}

Python

def ExecuteFilter():
    print("execute the filter")
    data = {"source_id": source_id}
    url = (
     "https://"
        + ip
        + "/api/v1/project/"
        + projectId
        + "/tools/filter/"
        + filterID_6
        + "/execute"
    )
    r = requests.post(url, data=data, verify=False, headers=hed)
    response = r.json()
    print(response)
    jobId = json.dumps(response["data"]["job_id"])
    jobFinished = False
    print("CHECK filter execute status...........")
    r = requests.get(
    "https://" + ip + "/api/v1/job/" + jobId + "?complete=true",
    verify=False,
    headers=hed,
    )
    response = r.json()
    print(response)
    jobState = json.dumps(response["data"]["state"])
    percentage = float(jobState) * 100
    print("Execute filter........: " + str(round(percentage, 2)) + "%\n")

    # Wait until job is done
    while jobState != "1":
        sleep(5)
        r = requests.get(
         "https://" + ip + "/api/v1/job/" + jobId + "?complete=true",
            verify=False,
            headers=hed,
        )
        response = r.json()
        print(response)
        jobState = json.dumps(response["data"]["state"])
        print(jobState)
        percentage = float(jobState) * 100
        print("Filter execute...... " + str(round(percentage, 2)) + "%\n")
    response = r.json()
    print(response)
    statusmessage = json.dumps(response["data"]["task"][0]["statusMessage"])
    print(statusmessage)

Step 10. Print the filter execution result

After the filter is executed , we can view the result using below API call. The result should contain all the objects that matches with the filter. From the response, you will parse the collection_Id to be used in the subsequent API call.

API syntax for the step:

Method	Route	Parameters
GET	`https://localhost/api/v1/project/{project_id}/tools/filter/{filter_id}/result`	in url "project_id":project_Id, "filter_id":filter_Id
example	`https://localhost/api/v1/project/22/tools/filter/6/result`

Python

print("Print the Filter Execution Result")
    url = (
        "https://"
        + ip
        + "/api/v1/project/"
        + projectId
        + "/tools/filter/"
        + filterID_6
        + "/result"
    )
    r = requests.get(url, verify=False, headers=hed)
    response = r.json()
    print(response)
    global Collection_ID
    Collection_ID = json.dumps(response["data"]["id"])

Step 11. Print the Collection Content

After the filter is executed , we can print the collection content using below API call.

API syntax for the step:

Method	Route	Parameters
GET	`https://localhost/api/v1/project/{project_id}/collection/{Collection_Id}/content`	in url "project_id":project_Id, "collection_id":collection_Id
example	`https://localhost/api/v1/project/22/collection/20793/content`

Python

print("***** Print the Collection that contain rules with specific subnets *****")
    url = "https://" + ip + "/api/v1/project/" + projectId + "/collection/" + Collection_ID + "/content"
    print(url)
    r = requests.get(url, verify=False, headers=hed)
    response = r.json()
    print(response)

The response will be similar to below which listed all security rules with source or destination address containing 10.1 .

** ** * Print the Collection that contain rules with specific subnets ** ** * {
    'data': {
        'id': 3111,
        'editable': False,
        'filter_id': 6,
        'type': 'filter',
        'content': [{
            'object_id': 3091,
            'name': 'Testrule1',
            'object_type': 'security_rule',
            'vsys_name': 'vsys1',
            'vsys': 2968,
            'source_name': 'pa220running-config',
            'source': 2966
        }, {
            'object_id': 3092,
            'name': 'Testrule2',
            'object_type': 'security_rule',
            'vsys_name': 'vsys1',
            'vsys': 2968,
            'source_name': 'pa220running-config',
            'source': 2966
        }, {
            'object_id': 3093,
            'name': 'Testrule2-1',
            'object_type': 'security_rule',
            'vsys_name': 'vsys1',
            'vsys': 2968,
            'source_name': 'pa220running-config',
            'source': 2966
        }],
        'name': 'collection_filter_6',
        'description': 'Collection for filter Combinefilter4_5'
    },
    'messages': [],
    'success': True

Step 1. Obtain the API Keys​

Step 2. Start the Expedition Agent​

Step 3. Add PAN-OS Device​

Step 4. Upload PAN-OS config into device​

Step 5. Create an Expedition Project​

Step 6. Import the PAN-OS configuration of your device to the project​

Step 7. Get Source ID of the config file​

Step 8. Create combined filters for security rules contain specific subnet​

1st Filter​

2nd Filter​

3rd Filter​

4th Filter​

5th Filter​

6th Filter​

Step 9. Execute the final filter​

Step 10. Print the filter execution result​

Step 11. Print the Collection Content​

Step 1. Obtain the API Keys

Step 2. Start the Expedition Agent

Step 3. Add PAN-OS Device

Step 4. Upload PAN-OS config into device

Step 5. Create an Expedition Project

Step 6. Import the PAN-OS configuration of your device to the project

Step 7. Get Source ID of the config file

Step 8. Create combined filters for security rules contain specific subnet

1st Filter

2nd Filter

3rd Filter

4th Filter

5th Filter

6th Filter

Step 9. Execute the final filter

Step 10. Print the filter execution result

Step 11. Print the Collection Content