Class PanDevice

Represents the base class for interaction with Palo Alto Networks devices. Provides methods to generate API keys, execute operational commands, and gather system and license information.

Hierarchy

Constructors

constructor

Properties

_apiClient children hostname name parent

Accessors

apiClient

Methods

addChild find findChildByName getChildren getConfig hasChild removeChild requestLicenseInfo showJobsAll showJobsId showSystemInfoResponse

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

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.

showSystemInfoResponse

  • showSystemInfoResponse(): Promise<any>

  • Retrieves system information and status from the PAN-OS device.

    Returns Promise<any>

    A promise resolving to the system information and status.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc