Paloalto MCP Server

🚀 Palo Alto Firewall API Usage Guide

This guide provides a comprehensive overview of using the Palo Alto Firewall API, including installation, quick start, detailed usage instructions, example codes, troubleshooting, and contribution guidelines.

🚀 Quick Start

📦 Installation

npm install palo-alto-api

💻 Basic Usage

Create a simple inbound rule:

await useMcpTool("paloalto-policy", "create_inbound_rule", {
  name: "Allow SSH Access",
  source: ["any"],
  destination: ["any"],
  service: ["ssh"]
});

Get all current inbound rules:

const rules = await useMcpTool("paloalto-policy", "get_inbound_rules", {});

Delete a specific inbound rule:

await useMcpTool("paloalto-policy", "delete_inbound_rule", {
  name: "Allow SSH Access"
});

💻 Usage Examples

🆕 Create Rules

Create an outbound rule to allow web browsing:

await useMcpTool("paloalto-policy", "create_outbound_rule", {
  name: "Allow Web Browsing",
  source: ["Internal Network"],
  destination: ["any"],
  service: ["web-browsing"]
});

📋 Get Rules

Get all security policies:

const securityPolicies = await useMcpTool("paloalto-policy", "get_security_policies", {});

Get a specific security policy by name:

const specificPolicy = await useMcpTool("paloalto-policy", "get_security_policy", {
  name: "Allow Web Browsing"
});

❌ Delete Rules

Delete a security policy:

await useMcpTool("paloalto-policy", "delete_security_policy", {
  name: "Allow Web Browsing"
});

🌟 Simple Example

async function createAndDeleteRule() {
  try {
    // Create a rule
    await useMcpTool("paloalto-policy", "create_outbound_rule", {
      name: "Temporary Access Rule",
      source: ["192.168.1.0/24"],
      destination: ["10.0.0.0/24"],
      service: ["icmp"]
    });

    // Get all rules
    const rules = await useMcpTool("paloalto-policy", "get_outbound_rules", {});

    console.log("Created Rules:", rules);

    // Delete the rule
    await useMcpTool("paloalto-policy", "delete_outbound_rule", {
      name: "Temporary Access Rule"
    });

  } catch (error) {
    console.error("Operation Failed:", error);
  }
}

createAndDeleteRule();

🔝 Advanced Example

async function applyConfigChanges() {
  try {
    // Create a new rule
    await useMcpTool("paloalto-policy", "create_security_policy", {
      name: "New Security Policy",
      source: ["192.168.0.0/16"],
      destination: ["172.16.0.0/12"],
      service: ["smtp"]
    });

    // Get all security policies
    const policies = await useMcpTool("paloalto-policy", "get_security_policies", {});

    console.log("All Security Policies:", policies);

    // Commit the changes
    await useMcpTool("paloalto-config", "commit_changes", {
      message: "Add New SMTP Rule"
    });

  } catch (error) {
    console.error("Configuration Application Failed:", error);
  }
}

applyConfigChanges();

🛠️ Troubleshooting

⚠️ Error Handling

try {
  // Try to create a rule
  await useMcpTool("paloalto-policy", "create_inbound_rule", {
    name: "Test Rule",
    source: ["invalid-network"],
    destination: ["any"],
    service: ["ftp"]
  });
} catch (error) {
  console.error("Error Message:", error);
}

📦 Bulk Operations

async function bulkOperations() {
  try {
    // Create multiple rules
    const newRules = [
      { name: "Rule 1", source: ["192.168.1.0/24"], destination: ["any"], service: ["http"] },
      { name: "Rule 2", source: ["192.168.2.0/24"], destination: ["any"], service: ["https"] }
    ];

    // Create rules using a loop
    for (const rule of newRules) {
      await useMcpTool("paloalto-policy", "create_outbound_rule", rule);
    }

    console.log("All New Rules Created");

    // Delete all rules
    const existingRules = await useMcpTool("paloalto-policy", "get_outbound_rules", {});

    for (const rule of existingRules) {
      await useMcpTool("paloalto-policy", "delete_outbound_rule", { name: rule.name });
    }

  } catch (error) {
    console.error("Bulk Operation Failed:", error);
  }
}

bulkOperations();

❓ Frequently Asked Questions

🤔 How to handle API errors?

It is always recommended to use a try-catch block to catch and handle possible errors when making any API calls:

try {
  // Execute an API call
} catch (error) {
  console.error("An Error Occurred:", error);
}

📨 How to commit changes?

After making all configuration changes, you must use the commit_changes method to commit the changes to make them effective:

await useMcpTool("paloalto-config", "commit_changes", {
  message: "Apply New Configuration"
});

🤝 Contribution Guidelines

🐛 Submit Bug Reports or Feature Requests

You are welcome to submit issues or feature requests through the following channels:

• GitHub Issues
• Support Center

💻 How to Contribute Code?

1. Fork the repository.
2. Create a new feature branch: git checkout -b feature/new-feature.
3. Commit your changes: git commit -m "Add New Feature".
4. Push to the remote branch: git push origin feature/new-feature.
5. Submit a Pull Request.

📄 License

• MIT License: Suitable for personal and commercial use, allowing free use, modification, and distribution.

For more information, please refer to Palo Alto API Documentation.