Class Firewall

Represents a Palo Alto Networks Firewall, extending PanDevice. Provides methods to interact with various firewall features such as resource monitoring, session management, routing information, URL categorization, and address objects.

Hierarchy

Constructors

constructor

Properties

_apiClient children hostname name parent

Accessors

apiClient

Methods

addChild addressObjectGetList find findChildByName getChildren getConfig hasChild removeChild requestLicenseInfo showJobsAll showJobsId showResourceMonitor showRoutingRoute showSessionAll showSessionAllFilter showSessionId showSessionInfo showSystemInfoResponse testUrlInfo

Constructors

constructor

Properties

Protected _apiClient

_apiClient: null | ApiClient

Protected children

children: PanObject[]

Protected hostname

hostname: string

name

name: string

Protected parent

parent: null | PanObject

Accessors

apiClient

  • get apiClient(): ApiClient

  • Retrieves the ApiClient from the current instance or its parent hierarchy.

    Returns ApiClient

    The ApiClient associated with this object.

    Throws

    An error if the ApiClient instance is not found in the hierarchy.

Methods

addChild

  • addChild(child): void

  • Adds a PanObject as a child to this object, establishing a parent-child relationship.

    Parameters

    • child: PanObject

      The PanObject to be added as a child.

    Returns void

addressObjectGetList

  • addressObjectGetList(): Promise<any[]>

  • Retrieves a list of all address objects configured on the firewall.

    Returns Promise<any[]>

    A promise that resolves with an array of address objects, each containing relevant details.

find

  • find<ObjectType>(name, classType?): null | ObjectType

  • Locates a child PanObject within the configuration tree by name and, optionally, by type.

    Type Parameters

    Parameters

    • name: string

      The name of the object to search for.

    • Optional classType: (new (...args) => ObjectType)

      Optional. The class constructor to match instances against.

        • new (...args): ObjectType

        • Parameters

          • Rest ...args: unknown[]

          Returns ObjectType

    Returns null | ObjectType

    The matching PanObject instance, or null if not found.

findChildByName

getChildren

getConfig

  • getConfig(xpath): Promise<any>

  • Retrieves configuration data from the device based on an XPath query.

    Parameters

    • xpath: string

      The XPath query specific to the object type being queried.

    Returns Promise<any>

    A promise resolving to the device's configuration data in parsed form.

hasChild

  • hasChild(child): boolean

  • Checks if a given PanObject is a child of this object.

    Parameters

    Returns boolean

    true if the specified PanObject is a child of this object, otherwise false.

removeChild

  • removeChild(child): void

  • Removes a PanObject from this object's children, severing the parent-child relationship.

    Parameters

    • child: PanObject

      The PanObject to be removed from the children.

    Returns void

requestLicenseInfo

  • requestLicenseInfo(): Promise<any>

  • Retrieves license information from the PAN-OS device.

    Returns Promise<any>

    A promise resolving to the license information from the device.

showJobsAll

  • showJobsAll(): Promise<any>

  • Retrieves details of all jobs processed by the PAN-OS device.

    Returns Promise<any>

    A promise resolving to the details of all jobs on the device.

showJobsId

  • showJobsId(jobId): Promise<any>

  • Retrieves details of a specific job using its unique identifier.

    Parameters

    • jobId: string

      The ID of the job to query.

    Returns Promise<any>

    A promise resolving to the details of the specified job.

showResourceMonitor

  • showResourceMonitor(): Promise<any>

  • Retrieves system resource monitoring data from the firewall.

    Returns Promise<any>

    A promise that resolves with the resource monitoring data including CPU and memory usage statistics.

showRoutingRoute

  • showRoutingRoute(): Promise<any>

  • Retrieves the routing table information from the firewall.

    Returns Promise<any>

    A promise that resolves with the details of the firewall's routing table.

showSessionAll

  • showSessionAll(): Promise<any>

  • Retrieves a list of all active sessions on the firewall.

    Returns Promise<any>

    A promise that resolves with details of all active sessions.

showSessionAllFilter

  • showSessionAllFilter(destinationIp, sourceIp): Promise<any>

  • Retrieves detailed information about firewall sessions based on source and destination IP filtering.

    Parameters

    • destinationIp: string

      The destination IP address to filter sessions by.

    • sourceIp: string

      The source IP address to filter sessions by.

    Returns Promise<any>

    A promise that resolves with session information filtered by the specified criteria.

showSessionId

  • showSessionId(sessionId): Promise<any>

  • Retrieves information about a specific session on the firewall using its session ID.

    Parameters

    • sessionId: string

      The unique identifier of the session.

    Returns Promise<any>

    A promise that resolves with details about the specified session.

showSessionInfo

  • showSessionInfo(): Promise<any>

  • Retrieves general information about the firewall's session states, configurations, and statistics.

    Returns Promise<any>

    A promise that resolves with general session information from the firewall.

showSystemInfoResponse

testUrlInfo

  • testUrlInfo(url): Promise<any>

  • Retrieves categorization information for a specified URL from the firewall.

    Parameters

    • url: string

      The URL to test categorization for.

    Returns Promise<any>

    A promise that resolves with the category information of the specified URL.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc