pan-os-ts-sdk v0.0.1

🌐 Panos TypeScript SDK

🚀 Introduction

Panos TypeScript SDK is a cutting-edge library crafted for seamless interaction with Palo Alto Networks firewalls and Panorama appliances. It's engineered to simplify the automation of tasks, streamline configurations, and efficiently retrieve data from PAN-OS devices.

🌟 Features

• 🔑 Effortless API key generation.
• 🛠️ Handy methods for routine PAN-OS operations.
• 🌐 Full compatibility with popular web frameworks like Angular and React.
• 🧩 Modular design with a structured approach to services and interfaces.

📦 Installation

To integrate Panos TypeScript SDK in your project, execute:

npm install pan-os-sdk

🌟 Getting Started

First, import the SDK into your project:

import Panos from 'pan-os-sdk';

Then, create an instance of the SDK:

const panosSdk = new Panos();

📚 Usage Examples

Generating an API Key

const apiKey = await panosSdk.firewallService.generateApiKey(
  username,
  password
);

Getting System Info

const systemInfo = await panosSdk.firewallService.getSystemInfo(apiKey);

// Log the systemInfo object
console.log("System Info:", JSON.stringify(systemInfo, null, 2));

API Documentation

Panos TypeScript SDK is composed of several components for streamlined interactions:

• BaseClient: Manages the core API interactions.
• DeviceService, FirewallService, NetworkService, PanoramaService: Specialized services for tailored operations.
• Interfaces: Define and ensure correct data structures for API responses.

For more detailed API documentation, refer to API Docs.

Contributing

Contributions to the Panos TypeScript SDK are welcome. Please ensure that your contributions adhere to the following guidelines:

• Write clear, concise code.
• Include unit tests for new features.
• Follow the existing coding style.

License

This project is licensed under the MIT License.

Contact

For questions or feedback, please contact me through a GitHub Issues