Module: plugins

Inheritance diagram

Inheritance diagram of panos.plugins

Configuration tree diagram

digraph configtree { graph [rankdir=LR, fontsize=10, margin=0.001]; node [shape=box, fontsize=10, height=0.001, margin=0.1, ordering=out]; AggBandwidth [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.AggBandwidth" target="_top"]; Region [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.Region" target="_top"]; AggBandwidth -> Region; CloudServicesPlugin [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.CloudServicesPlugin" target="_top"]; AccessDomain [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.AccessDomain" target="_top"]; CloudServicesPlugin -> AccessDomain; RemoteNetworks [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.RemoteNetworks" target="_top"]; CloudServicesPlugin -> RemoteNetworks; RoutingPreference [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.RoutingPreference" target="_top"]; CloudServicesPlugin -> RoutingPreference; Tenants [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.Tenants" target="_top"]; CloudServicesPlugin -> Tenants; InternalDnsMatch [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.InternalDnsMatch" target="_top"]; PrimaryInternalDNSServer [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.PrimaryInternalDNSServer" target="_top"]; InternalDnsMatch -> PrimaryInternalDNSServer; SecondaryInternalDNSServer [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.SecondaryInternalDNSServer" target="_top"]; InternalDnsMatch -> SecondaryInternalDNSServer; Link [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.Link" target="_top"]; Bgp [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.Bgp" target="_top"]; Link -> Bgp; RemoteNetwork [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.RemoteNetwork" target="_top"]; RemoteNetwork -> Bgp; BgpPeer [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.BgpPeer" target="_top"]; RemoteNetwork -> BgpPeer; RemoteNetwork -> Link; RemoteNetworks -> AggBandwidth; RemoteNetworks -> InternalDnsMatch; PrimaryPublicDNSServer [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.PrimaryPublicDNSServer" target="_top"]; RemoteNetworks -> PrimaryPublicDNSServer; RemoteNetworks -> RemoteNetwork; SecondaryPublicDNSServer [style=filled fillcolor=wheat URL="../module-plugins.html#panos.plugins.SecondaryPublicDNSServer" target="_top"]; RemoteNetworks -> SecondaryPublicDNSServer; Tenants -> RemoteNetworks; }

Class Reference

Prisma Access module contains objects that exist in the ‘Plugins/Cloud Services’ tab in the Panorama GUI

class panos.plugins.AccessDomain(*args, **kwargs)[source]

Prisma Access Multi Tenant Access Domain Configuration :param name: Tenant Name :type name: str :param device_groups: Device Group Names :type device_groups: list :param templates: Template and Templates Stack Names :type templates: list

class panos.plugins.AggBandwidth(*args, **kwargs)[source]

Prisma Access remote networks Aggregated Bandwidth configuration base object

Parameters:enabled (bool) – Whether Aggregated BW mode is enabled or not
class panos.plugins.Bgp(*args, **kwargs)[source]

Prisma Access BGP configuration object

Parameters:
  • enable (bool) – Whether BGP is enabled or not.
  • originate_default_route (bool) – Originate default route
  • summarize_mobile_user_routes (bool) – Summarize mobile users routes or not
  • do_not_export_routes (bool) – Do not export routes
  • peer_as (int) – Peer AS
  • peer_ip_address (str) – Peer IP Address
  • local_ip_address (str) – Local IP Address
  • secret (str) – BGP Password
class panos.plugins.BgpPeer(*args, **kwargs)[source]

Prisma Access BGP Peer configuration object

Parameters:
  • same_as_primary (bool) –
  • peer_ip_address (str) – Peer IP Address
  • local_ip_address (str) – Local IP Address
  • secret (str) – BGP Password
class panos.plugins.CloudServicesJobsStatus(obj)[source]

Operational state handling for Cloud Services Plugins jobs.

refresh(service_type=None, failed=True, success=True, pending=True)[source]

Retrieves the prisma commit jobs status. The data will also be stored in self.status, indexed by job type: To get by job status: self.status[‘pending-jobs’] -> Will return list of pending jobs

Parameters:
  • service_type (str/list) – Service type of jobs to refresh. Can be a string or list with values: mobile-users, remote-networks, clean-pipe, service-connection, or None to get all jobs
  • failed (bool) – Default True. Retrieve failed jobs or not
  • success (bool) – Default True. Retrieve success jobs or not
  • pending (bool) – Default True. Retrieve pending jobs or not
Returns:

A dict where the key is the service type. each service type is a dict with failed, success, pending jobs

Return type:

dict

class panos.plugins.CloudServicesJobsStatusDetails(obj)[source]

Operational state handling for Cloud Services Plugin detailed job status.

refresh(job_id, service_type)[source]

Retrieves a prisma commit jobs details

Parameters:
  • job_id (int) – the job ID to get details from
  • service_type (str/list) – Service type of jobs to refresh. Can be a string or list with values: mobile-users, remote-networks, clean-pipe, service-connection.
Returns:

A dict with the details of job ‘job_id’. See _parse_response for structure of the output dict.

Note: for mobile-users, the details will contains both gpgateways and gpportals entries, for remote-networks it will have remote_networks, and for service-connection, it will have service_connection

Return type:

dict

class panos.plugins.CloudServicesPlugin(*args, **kwargs)[source]

Prisma Access configuration base object

Parameters:
  • all_traffic_to_dc (bool) – Send All Traffic to DC Option
  • multi_tenant_enable (bool) – Multi Tenants enabled or not
class panos.plugins.DNSServerBase(*args, **kwargs)[source]

Abstract DNS Class, will be inherited for correct XPATH

Parameters:
  • dns_server (str) – IP of DNS Server
  • use-cloud-default (bool) – Use cloud default DNS
  • same_as_internal (bool) – Use same DNS server as Internal
class panos.plugins.InternalDnsMatch(*args, **kwargs)[source]

Prisma Access remote-networks Internal DNS entry configuration base object

Parameters:domain_list (list/str) – Internal Domains names

Prisma Access ECMP Links config object

Parameters:
  • name (str) – Link Name
  • ipsec_tunnel (str) – IPSEC Tunnel Name
class panos.plugins.PrimaryInternalDNSServer(*args, **kwargs)[source]

A primary Internal DNS Server for remote networks

Parameters:
  • dns_server (str) – IP of DNS Server
  • use_cloud_default (bool) – Use cloud default DNS
class panos.plugins.PrimaryPublicDNSServer(*args, **kwargs)[source]

A primary Public DNS Server for remote networks

Parameters:
  • dns_server (str) – IP of DNS Server
  • use_cloud_default (bool) – Use cloud default DNS
  • same_as_internal (bool) – Use same DNS server as Internal
class panos.plugins.Region(*args, **kwargs)[source]

Prisma Access remote networks Aggregated Bandwidth configuration base object

Parameters:
  • name (str) – Region Name
  • allocated_bw (int) – Allocated BW in Mbps
  • spn_name_list (list/str) – Names of the SPN for the region
class panos.plugins.RemoteNetwork(*args, **kwargs)[source]

Prisma Access Remote-Networks Onboarding configuration base object

Parameters:
  • name (str) – Remote Network Name
  • subnets (list/str) – Static Routes
  • region (str) – Remote Network Region Name
  • license_type (str) – License Type
  • ipsec_tunnel (str) – IPSEC tunnel Name
  • secondary_wan_enabled (bool) – Secondary WAN Enabled ?
  • ecmp_load_balancing (bool) – Enabled ECMP or not
  • secondary_ipsec_tunnel (str) – Name of secondary IPSEC tunnel
  • spn_name (str) – SPN Name of the remote network
  • inbound_flow_over_pa_backbone (bool) – inbound flow over pa backbone
class panos.plugins.RemoteNetworks(*args, **kwargs)[source]

Prisma Access Remote-Networks configuration base object

Parameters:
  • overlapped_subnets (bool) – Whether or not overlapped subnets are enabled
  • template_stack (str) – Remote Networks Template stack
  • device_group (str) – Remote Networks device group
  • trusted_zones (list/str) – Remote Networks trusted zones
  • udp_query_interval (int) – DNS UDP Query interval
  • udp_query_attempts (int) – DNS UDP Query attempts
class panos.plugins.RoutingPreference(*args, **kwargs)[source]

Prisma Access routing-preference configuration base object

Parameters:
  • default (bool) – Default Routing Mode
  • hot_potato_routing (bool) – Hot Potato Routing Mode
class panos.plugins.SecondaryInternalDNSServer(*args, **kwargs)[source]

A Secondary Internal DNS Server for remote networks

Parameters:
  • dns_server (str) – IP of DNS Server
  • use_cloud_default (bool) – Use cloud default DNS
class panos.plugins.SecondaryPublicDNSServer(*args, **kwargs)[source]

A secondary Internal DNS Server for remote networks

Parameters:
  • dns_server (str) – IP of DNS Server
  • use_cloud_default (bool) – Use cloud default DNS
  • same_as_internal (bool) – Use same DNS server as Internal
class panos.plugins.Tenants(*args, **kwargs)[source]

Prisma Access Multi Tenants/Tenant Configuration :param name: Tenant Name :type name: str :param access_domain: Access Domain Name :type access_domain: str :param bandwidth: Bandwitdh allocated to tenant :type bandwidth: int :param bandwidth_adem: Adem Bandwitdh allocated to tenant :type bandwidth_adem: int :param bandwidth_cleanpipe: CleanPipe Bandwitdh allocated to tenant :type bandwidth_cleanpipe: int :param users: Numbers of mobile users for the tenant :type users: int :param adem_users: Numbers of adem users for the tenant :type adem_users: int