Paloalto MCP Server

🚀 Palo Alto 防火牆 API 使用指南

本指南將幫助你快速上手並熟練使用 Palo Alto 防火牆 API，通過簡單的代碼示例，你可以輕鬆創建、獲取和刪除防火牆規則，實現靈活的網絡安全策略配置。

🚀 快速開始

📦 安裝

使用以下命令安裝 palo-alto-api：

npm install palo-alto-api

💻 使用示例

基礎用法

創建一條簡單的入站規則：

await useMcpTool("paloalto-policy", "create_inbound_rule", {
  name: "允許 SSH 訪問",
  source: ["any"],
  destination: ["any"],
  service: ["ssh"]
});

獲取所有當前的入站規則：

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

刪除特定的入站規則：

await useMcpTool("paloalto-policy", "delete_inbound_rule", {
  name: "允許 SSH 訪問"
});

高級用法

創建一條出站規則以允許 Web 瀏覽：

await useMcpTool("paloalto-policy", "create_outbound_rule", {
  name: "允許網頁瀏覽",
  source: ["內部網絡"],
  destination: ["any"],
  service: ["web-browsing"]
});

獲取所有安全策略：

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

獲取特定名稱的安全策略：

const specificPolicy = await useMcpTool("paloalto-policy", "get_security_policy", {
  name: "允許網頁瀏覽"
});

刪除一條安全策略：

await useMcpTool("paloalto-policy", "delete_security_policy", {
  name: "允許網頁瀏覽"
});

📚 詳細文檔

示例代碼

基礎用法

async function createAndDeleteRule() {
  try {
    // 創建規則
    await useMcpTool("paloalto-policy", "create_outbound_rule", {
      name: "臨時訪問規則",
      source: ["192.168.1.0/24"],
      destination: ["10.0.0.0/24"],
      service: ["icmp"]
    });

    // 獲取所有規則
    const rules = await useMcpTool("paloalto-policy", "get_outbound_rules", {});

    console.log("創建的規則:", rules);

    // 刪除規則
    await useMcpTool("paloalto-policy", "delete_outbound_rule", {
      name: "臨時訪問規則"
    });

  } catch (error) {
    console.error("操作失敗:", error);
  }
}

createAndDeleteRule();

高級用法

async function applyConfigChanges() {
  try {
    // 創建新規則
    await useMcpTool("paloalto-policy", "create_security_policy", {
      name: "新安全策略",
      source: ["192.168.0.0/16"],
      destination: ["172.16.0.0/12"],
      service: ["smtp"]
    });

    // 獲取所有安全策略
    const policies = await useMcpTool("paloalto-policy", "get_security_policies", {});

    console.log("所有安全策略:", policies);

    // 提交更改
    await useMcpTool("paloalto-config", "commit_changes", {
      message: "添加新 SMTP 規則"
    });

  } catch (error) {
    console.error("配置應用失敗:", error);
  }
}

applyConfigChanges();

常見問題和故障排除

錯誤處理

try {
  // 嘗試創建規則
  await useMcpTool("paloalto-policy", "create_inbound_rule", {
    name: "測試規則",
    source: ["invalid-network"],
    destination: ["any"],
    service: ["ftp"]
  });
} catch (error) {
  console.error("錯誤信息:", error);
}

批處理操作

async function bulkOperations() {
  try {
    // 創建多條規則
    const newRules = [
      { name: "規則1", source: ["192.168.1.0/24"], destination: ["any"], service: ["http"] },
      { name: "規則2", source: ["192.168.2.0/24"], destination: ["any"], service: ["https"] }
    ];

    // 使用循環創建規則
    for (const rule of newRules) {
      await useMcpTool("paloalto-policy", "create_outbound_rule", rule);
    }

    console.log("所有新規則已創建");

    // 刪除所有規則
    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("批量操作失敗:", error);
  }
}

bulkOperations();

常見問題

如何處理 API 錯誤？

在進行任何 API 調用時，始終建議使用 try-catch 塊來捕獲和處理可能的錯誤：

try {
  // 執行 API 調用
} catch (error) {
  console.error("出現錯誤:", error);
}

如何提交更改？

在完成所有配置更改後，必須使用 commit_changes 方法提交更改以使它們生效：

await useMcpTool("paloalto-config", "commit_changes", {
  message: "應用新配置"
});

貢獻指南

提交錯誤報告或功能請求

歡迎通過以下方式提交問題或功能請求：

• GitHub Issues
• 支持中心

如何貢獻代碼？

1. Fork 倉庫
2. 創建新功能分支：git checkout -b feature/new-feature
3. 提交更改：git commit -m "添加新功能"
4. 推送到遠程分支：git push origin feature/new-feature
5. 提交 Pull Request

📄 許可證

• MIT License：適用於個人和商業用途，允許自由使用、修改和分發。

如需更多信息，請參考 Palo Alto API 文檔。