Edits a configuration entity on the PAN-OS device.
The XPath of the configuration to be edited.
The configuration's XML representation.
Optional entryName: stringOptional. The name of the configuration entry to be edited.
A promise that resolves to a string containing the raw XML response from the configuration edit API call.
Generates an API key for the PAN-OS device.
The API endpoint for key generation.
The parameters for the API key generation request.
A promise that resolves to the generated API key.
An error if the API key generation fails.
Performs an HTTP GET request to the specified endpoint on the PAN-OS device.
The API endpoint to send the request to.
Optional params: Record<string, unknown>Optional parameters to include in the request.
A promise that resolves to a string containing the raw XML response.
Retrieves a specified configuration from the PAN-OS device, with options to parse the response.
The XPath of the configuration to be retrieved.
Optional. Whether to parse the XML response into a JavaScript object. Defaults to true.
The configuration data, either as a raw XML string or as an ApiResponse<ApiResult>.
Retrieves and optionally parses data from the PAN-OS API.
The API endpoint to send the request to.
Optional params: Record<string, unknown>Optional parameters to include in the request.
A promise that resolves to the response data, either as a raw XML string or as an ApiResponse<T>.
T The expected type of the API result.
Retrieves raw data from the PAN-OS API.
The API endpoint to send the request to.
Optional params: Record<string, unknown>Optional parameters to include in the request.
A promise that resolves to a string containing the raw XML response.
Executes an operational command on the PAN-OS device and retrieves the result.
The command string or XML to execute.
Optional. Whether to parse the command response into a JavaScript object. Defaults to true.
The response from the operational command, either as raw XML or an object.
T The expected type of the API result structure.
Parses an XML string into a JavaScript object structure.
The XML string to parse.
Optional. Forces arrays for child elements if set to true. Defaults to false.
Optional. Ignores XML attributes and only creates text nodes if set to true. Defaults to true.
A promise resolved with the parsed object structure.
T The expected type of the API result structure.
Performs an HTTP POST request to the specified endpoint on the PAN-OS device.
The API endpoint to send the request to.
The XML string to be sent as the request body.
A promise that resolves to a string containing the raw XML response.
Sends a configuration change to the PAN-OS device via an API POST request.
The XPath of the configuration to be updated.
The configuration's XML representation.
The configuration action to perform (set, edit, or delete).
A promise that resolves to a string containing the raw XML response.
Creates a configuration entity on the PAN-OS device.
The XPath of the configuration to be created.
The configuration's XML representation.
A promise that resolves to a string containing the raw XML response from the configuration creation API call.
Generated using TypeDoc
Client for interacting with the Palo Alto Networks XML API. Encapsulates methods for performing HTTP GET and POST requests with XML data and conversion utilities for API operations.