Manage Deployment Profiles Using the Licensing API
Table of Contents
PAN.OS 11.1 & Later
Expand all | Collapse all
-
- VM-Series Deployments
- VM-Series in High Availability
- IPv6 Support on Public Cloud
- Enable Jumbo Frames on the VM-Series Firewall
- Hypervisor Assigned MAC Addresses
- Custom PAN-OS Metrics Published for Monitoring
- Interface Used for Accessing External Services on the VM-Series Firewall
- PacketMMAP and DPDK Driver Support
- Enable NUMA Performance Optimization on the VM-Series
- Enable ZRAM on the VM-Series Firewall
-
- Licensing and Prerequisites for Virtual Systems Support on VM-Series
- System Requirements for Virtual Systems Support on VM-Series
- Enable Multiple Virtual Systems Support on VM-Series Firewall
- Enable Multiple Virtual Systems Support on VM-Series in Panorama Console
- Enable Multiple Virtual Systems Support Using Bootstrap Method
-
- VM-Series Firewall Licensing
- Create a Support Account
- Serial Number and CPU ID Format for the VM-Series Firewall
- Use Panorama-Based Software Firewall License Management
-
- Activate Credits
- Create a Deployment Profile
- Activate the Deployment Profile
- Manage a Deployment Profile
- Register the VM-Series Firewall (Software NGFW Credits)
- Provision Panorama
- Migrate Panorama to a Software NGFW License
- Transfer Credits
- Renew Your Software NGFW Credits
- Deactivate License (Software NGFW Credits)
- Delicense Ungracefully Terminated Firewalls
- Set the Number of Licensed vCPUs
- Customize Dataplane Cores
- Migrate a Firewall to a Flexible VM-Series License
-
- Generate Your OAuth Client Credentials
- Manage Deployment Profiles Using the Licensing API
- Create a Deployment Profile Using the Licensing API
- Update a Deployment Profile Using the Licensing API
- Get Serial Numbers Associated with an Authcode Using the API
- Deactivate a VM-Series Firewall Using the API
- What Happens When Licenses Expire?
-
- Supported Deployments on VMware vSphere Hypervisor (ESXi)
-
- Plan the Interfaces for the VM-Series for ESXi
- Provision the VM-Series Firewall on an ESXi Server
- Perform Initial Configuration on the VM-Series on ESXi
- Add Additional Disk Space to the VM-Series Firewall
- Use VMware Tools on the VM-Series Firewall on ESXi and vCloud Air
- Use vMotion to Move the VM-Series Firewall Between Hosts
- Use the VM-Series CLI to Swap the Management Interface on ESXi
- Configure Link Aggregation Control Protocol
-
-
- Supported Deployments of the VM-Series Firewall on VMware NSX-T (North-South)
- Components of the VM-Series Firewall on NSX-T (North-South)
-
- Install the Panorama Plugin for VMware NSX
- Enable Communication Between NSX-T Manager and Panorama
- Create Template Stacks and Device Groups on Panorama
- Configure the Service Definition on Panorama
- Deploy the VM-Series Firewall
- Direct Traffic to the VM-Series Firewall
- Apply Security Policy to the VM-Series Firewall on NSX-T
- Use vMotion to Move the VM-Series Firewall Between Hosts
- Extend Security Policy from NSX-V to NSX-T
-
- Components of the VM-Series Firewall on NSX-T (East-West)
- VM-Series Firewall on NSX-T (East-West) Integration
- Supported Deployments of the VM-Series Firewall on VMware NSX-T (East-West)
-
- Install the Panorama Plugin for VMware NSX
- Enable Communication Between NSX-T Manager and Panorama
- Create Template Stacks and Device Groups on Panorama
- Configure the Service Definition on Panorama
- Launch the VM-Series Firewall on NSX-T (East-West)
- Add a Service Chain
- Direct Traffic to the VM-Series Firewall
- Apply Security Policies to the VM-Series Firewall on NSX-T (East-West)
- Use vMotion to Move the VM-Series Firewall Between Hosts
-
- Install the Panorama Plugin for VMware NSX
- Enable Communication Between NSX-T Manager and Panorama
- Create Template Stacks and Device Groups on Panorama
- Configure the Service Definition on Panorama
- Launch the VM-Series Firewall on NSX-T (East-West)
- Create Dynamic Address Groups
- Create Dynamic Address Group Membership Criteria
- Generate Steering Policy
- Generate Steering Rules
- Delete a Service Definition from Panorama
- Migrate from VM-Series on NSX-T Operation to Security Centric Deployment
- Extend Security Policy from NSX-V to NSX-T
- Use In-Place Migration to Move Your VM-Series from NSX-V to NSX-T
-
-
- Deployments Supported on AWS
-
- Planning Worksheet for the VM-Series in the AWS VPC
- Launch the VM-Series Firewall on AWS
- Launch the VM-Series Firewall on AWS Outpost
- Create a Custom Amazon Machine Image (AMI)
- Encrypt EBS Volume for the VM-Series Firewall on AWS
- Use the VM-Series Firewall CLI to Swap the Management Interface
- Enable CloudWatch Monitoring on the VM-Series Firewall
- VM-Series Firewall Startup and Health Logs on AWS
- Use AWS Secrets Manager to Store VM-Series Certificates
- Use Case: Secure the EC2 Instances in the AWS Cloud
- Use Case: Use Dynamic Address Groups to Secure New EC2 Instances within the VPC
-
- Intelligent Traffic Offload
- Software Cut-through Based Offload
-
- Deployments Supported on Azure
- Deploy the VM-Series Firewall from the Azure Marketplace (Solution Template)
- Deploy the VM-Series Firewall from the Azure China Marketplace (Solution Template)
- Deploy the VM-Series with the Azure Gateway Load Balancer
- Create a Custom VM-Series Image for Azure
- Deploy the VM-Series Firewall on Azure Stack
- Deploy the VM-Series Firewall on Azure Stack HCI
- Enable Azure Application Insights on the VM-Series Firewall
- Set up Active/Passive HA on Azure
- Use Azure Key Vault to Store VM-Series Certificates
- Use the ARM Template to Deploy the VM-Series Firewall
-
- About the VM-Series Firewall on Google Cloud Platform
- Supported Deployments on Google Cloud Platform
- Create a Custom VM-Series Firewall Image for Google Cloud Platform
- Prepare to Set Up VM-Series Firewalls on Google Public Cloud
-
- Deploy the VM-Series Firewall from Google Cloud Platform Marketplace
- Management Interface Swap for Google Cloud Platform Load Balancing
- Use the VM-Series Firewall CLI to Swap the Management Interface
- Enable Google Stackdriver Monitoring on the VM Series Firewall
- Enable VM Monitoring to Track VM Changes on Google Cloud Platform (GCP)
- Use Dynamic Address Groups to Secure Instances Within the VPC
- Use Custom Templates or the gcloud CLI to Deploy the VM-Series Firewall
- Enable Session Resiliency on VM-Series for GCP
-
- Prepare Your ACI Environment for Integration
-
-
- Create a Virtual Router and Security Zone
- Configure the Network Interfaces
- Configure a Static Default Route
- Create Address Objects for the EPGs
- Create Security Policy Rules
- Create a VLAN Pool and Domain
- Configure an Interface Policy for LLDP and LACP for East-West Traffic
- Establish the Connection Between the Firewall and ACI Fabric
- Create a VRF and Bridge Domain
- Create an L4-L7 Device
- Create a Policy-Based Redirect
- Create and Apply a Service Graph Template
-
- Create a VLAN Pool and External Routed Domain
- Configure an Interface Policy for LLDP and LACP for North-South Traffic
- Create an External Routed Network
- Configure Subnets to Advertise to the External Firewall
- Create an Outbound Contract
- Create an Inbound Web Contract
- Apply Outbound and Inbound Contracts to the EPGs
- Create a Virtual Router and Security Zone for North-South Traffic
- Configure the Network Interfaces
- Configure Route Redistribution and OSPF
- Configure NAT for External Connections
-
-
- Choose a Bootstrap Method
- VM-Series Firewall Bootstrap Workflow
- Bootstrap Package
- Bootstrap Configuration Files
- Generate the VM Auth Key on Panorama
- Create the bootstrap.xml File
- Prepare the Licenses for Bootstrapping
- Prepare the Bootstrap Package
- Bootstrap the VM-Series Firewall on AWS
- Bootstrap the VM-Series Firewall on Azure
- Bootstrap the VM-Series Firewall on Azure Stack HCI
- Bootstrap the VM-Series Firewall on Google Cloud Platform
- Verify Bootstrap Completion
- Bootstrap Errors
Manage Deployment Profiles Using the Licensing API
Use the following APIs to retrieve a deployment profile, view deployment profile
information, or delete a deployment profile.
Use the following APIs to retrieve information about an existing deployment profile or to
delete a deployment profile you are no longer using.
- Get All Credit Pools
- Get a Credit Pool by Credit Pool ID
- Get All Deployment Profiles in a Credit Pool
- Get a Deployment Profile
- Delete a Deployment Profile
Get All Credit Pools
Use this API to retrieve information about all credit pools associated with your CSP
account.
Header Parameters: token
Request Method: GET
URL: https://api.paloaltonetworks.com/tms/v1/creditPool
Sample API request:
curl --location --request GET 'https://api.paloaltonetworks.com/tms/v1/creditPool' \ --header 'token: <your-token>'
Sample API response:
{ "data": [ { "creditPoolId": 31586#####, "poolName": "Software NGFW Credits", "supportType": "Platinum", "expirationDate": "02/07/2026", "totalCredits": 27.84, "creditsAllocated": 0.0, "creditsConsumed": 0.0, "creditsAvailable": 27.84 }, { "creditPoolId": 99394#####, "poolName": "Software NGFW Credits", "supportType": "Premium", "expirationDate": "10/27/2023", "totalCredits": 47.0, "creditsAllocated": 13.68, "creditsConsumed": 0.0, "creditsAvailable": 33.32 }, { "creditPoolId": 90775#####, "poolName": "Software NGFW Credits", "supportType": "Premium Partner", "expirationDate": "04/13/2025", "totalCredits": 34.0, "creditsAllocated": 0.0, "creditsConsumed": 0.0, "creditsAvailable": 34.0 } ] }
Get a Credit Pool by Credit Pool ID
Header Parameters: token
Path Parameters: creditPoolId
Request Method: GET
URL:
https://api.paloaltonetworks.com/tms/v1/creditPool/{creditPoolId}
Sample API request:
curl --location --request GET 'https://api.paloaltonetworks.com/tms/v1/creditPool/<creditPoolId>' \ --header 'token: <your-token>'
Sample API response:
{ "data": { "creditPoolId": 97101#####, "poolName": "Software NGFW Credits", "supportType": "Premium", "expirationDate": "02/20/2026", "totalCredits": 194.0, "creditsAllocated": 172.75, "creditsConsumed": 43.94, "creditsAvailable": 21.25 } }
Get All Deployment Profiles in a Credit Pool
Use this API to get the details of a specific deployment profile.
Header Parameters: token
Path Parameters: creditPoolId
Request Method: GET
URL:
https://api.paloaltonetworks.com/tms/v1/creditPool/{creditPoolId}/deploymentProfile
Sample API request:
curl --location --request GET 'https://api.paloaltonetworks.com/tms/v1/creditPool/<creditPoolId>/deploymentProfile' \ --header 'token:<your-token>'
Sample API response:
{ "data": [ { "profileName": "Credit Pool 1", "dAuthCode": "D#######", "type": "VM", "panOsVersion": "10.0.4_or-above", "creditsAllocated": 41.860000610351562, "creditsConsumed": 20.930000305175781, "vCpuConsumed": 2, "vCpuAllocated": 4, "fWsDeployed": 1, "fWsPlanned": 2, "status": "Updated" }, { "profileName": "Credit Pool 2", "dAuthCode": "D#######", "type": "VM", "panOsVersion": "10.0.3_or-below", "creditsAllocated": 32.200000762939453, "creditsConsumed": 0.0, "vCpuConsumed": 0, "vCpuAllocated": 4, "fWsDeployed": 0, "fWsPlanned": 2, "status": "Created" } ] }
Get a Deployment Profile
Use this API to get the details of a specific deployment profile.
Header Parameters: token
Path Parameters: authCode
Request Method: GET
URL:
https://api.paloaltonetworks.com/tms/v1/deploymentProfile/{authCode}
Sample API request:
curl --location --request GET 'https://api.paloaltonetworks.com/tms/v1/deploymentProfile/<authCode>' \ --header 'token:<your-token>'
Sample API response:
{ "data": { "profileName": "deployment-profile-1", "dAuthCode": "D#######", "type": "VM", "panOsVersion": "10.0.3_or-below", "creditsAllocated": 43.7, "creditsConsumed": 0.0, "vCpuConsumed": 0, "vCpuAllocated": 8, "fWsDeployed": 0, "fWsPlanned": 1, "status": "Updated" } } }
Delete a Deployment Profile
Use this API to delete a specific deployment profile.
Header Parameters: token
Path Parameters: authCode
Request Method: DELETE
URL:
https://api.paloaltonetworks.com/v1/deployment-profile/auth-code/{auth-code}
Sample API request:
curl --location --request DELETE 'https://api.paloaltonetworks.com//tms/v1/deploymentProfile/<authCode>' \ --header 'token:<your-token>'
Sample API response:
{ "isDeleted": true, "dAuthcode": "D#######", "message": "Deleted" }