pa_api.restapi

1from . import rest_resources, restapi
2from .restapi import PanoramaClient
3
4__all__ = [
5    "restapi",
6    "rest_resources",
7    "PanoramaClient",
8]
class PanoramaClient:
266class PanoramaClient:
267    """
268    Wrapper for the PaloAlto REST API
269    Resources (e.g. Addresses, Tags, ..) are grouped under their resource types.
270    See https://docs.paloaltonetworks.com/pan-os/10-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/access-the-rest-api#id0e536ca4-6154-4188-b70f-227c2c113ec4
271
272    Attributes:
273
274        - objects: groups all the objects (Address, Tag, Service, ...)
275        - policies: groups all the policies (Security, NAT, ...)
276        - network: groups all the network resources (e.g. EthernetInterfaces, VLANInterfaces, ...)
277        - device: groups all device-related resources (only VirtualSystems)
278        - panorama: groups all panorama-management-related resources (only DeviceGroups)
279    """
280
281    objects: PanoramaObjectsResourceType
282    policies: PanoramaPoliciesResourceType
283    network: PanoramaNetworkResourceType
284    device: PanoramaDevicesResourceType
285    panorama: PanoramaPanoramaResourceType
286
287    def __init__(
288        self,
289        domain,
290        api_key=None,
291        version="v10.1",
292        verify=False,
293        verbose=False,
294    ):
295        domain, _, _ = clean_url_host(domain)
296        client = PanoramaAPI(api_key=api_key, verbose=verbose, verify=verify)
297        self.client = client
298        self.objects = PanoramaObjectsResourceType(client, domain, version=version)
299        self.policies = PanoramaPoliciesResourceType(client, domain, version=version)
300        self.network = PanoramaNetworkResourceType(client, domain, version=version)
301        self.device = PanoramaDevicesResourceType(client, domain, version=version)
302        self.panorama = PanoramaPanoramaResourceType(client, domain, version=version)

Wrapper for the PaloAlto REST API Resources (e.g. Addresses, Tags, ..) are grouped under their resource types. See https://docs.paloaltonetworks.com/pan-os/10-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/access-the-rest-api#id0e536ca4-6154-4188-b70f-227c2c113ec4

Attributes:

- objects: groups all the objects (Address, Tag, Service, ...)
- policies: groups all the policies (Security, NAT, ...)
- network: groups all the network resources (e.g. EthernetInterfaces, VLANInterfaces, ...)
- device: groups all device-related resources (only VirtualSystems)
- panorama: groups all panorama-management-related resources (only DeviceGroups)
PanoramaClient(domain, api_key=None, version='v10.1', verify=False, verbose=False)
287    def __init__(
288        self,
289        domain,
290        api_key=None,
291        version="v10.1",
292        verify=False,
293        verbose=False,
294    ):
295        domain, _, _ = clean_url_host(domain)
296        client = PanoramaAPI(api_key=api_key, verbose=verbose, verify=verify)
297        self.client = client
298        self.objects = PanoramaObjectsResourceType(client, domain, version=version)
299        self.policies = PanoramaPoliciesResourceType(client, domain, version=version)
300        self.network = PanoramaNetworkResourceType(client, domain, version=version)
301        self.device = PanoramaDevicesResourceType(client, domain, version=version)
302        self.panorama = PanoramaPanoramaResourceType(client, domain, version=version)
client