Esxi MCP Server

🚀 ESXi MCP 服务器管理器

ESXi MCP 服务器管理器是一个基于 MCP（模型控制协议）的 VMware ESXi/vCenter 管理服务器，它提供简单的 REST API 接口，可用于高效地管理虚拟机，为用户带来便捷的虚拟机管理体验。

🚀 快速开始

1. 安装依赖项：

pip install pyvmomi pyyaml uvicorn mcp-core

2. 创建配置文件 config.yaml：

vcenter_host: "your-vcenter-ip"
vcenter_user: "administrator@vsphere.local"
vcenter_password: "your-password"
datacenter: "your-datacenter"        # 可选
cluster: "your-cluster"              # 可选
datastore: "your-datastore"          # 可选
network: "VM Network"                # 可选
insecure: true                       # 忽略 SSL 证书验证
api_key: "your-api-key"             # API 访问密钥
log_file: "./logs/vmware_mcp.log"   # 日志文件路径
log_level: "INFO"                    # 日志级别

3. 运行服务器：

python server.py -c config.yaml

✨ 主要特性

• 广泛的连接支持：支持 ESXi 和 vCenter Server 连接。
• 实时通信能力：基于 SSE（服务器发送事件）的实时通信。
• 灵活的 API 接口：RESTful API 接口，支持 JSON - RPC。
• 安全的认证机制：API 密钥认证。
• 全面的生命周期管理：完整的虚拟机生命周期管理。
• 实时性能监控：可实时监控 CPU 使用率、内存使用率、存储使用率和网络流量统计等。
• 安全连接保障：支持 SSL/TLS 安全连接。
• 灵活的配置方式：支持 YAML/JSON/环境变量等灵活的配置选项。

📦 安装指南

本项目的安装需要满足以下需求：

• Python 3.7+
• pyVmomi
• PyYAML
• uvicorn
• mcp - core（机器控制协议核心库）

安装依赖项的命令如下：

pip install pyvmomi pyyaml uvicorn mcp-core

💻 使用示例

基础用法

认证

所有特权操作都需要先进行认证：

POST /sse/messages
Authorization: Bearer your-api-key

创建 VM

{
    "name": "vm-name",
    "cpu": 2,
    "memory": 4096,
    "datastore": "数据存储名称",
    "network": "网络名称"
}

克隆 VM

{
    "template_name": "源 VM 名称",
    "new_name": "新 VM 名称"
}

删除 VM

{
    "name": "vm-name"
}

电源操作

{
    "name": "vm-name"
}

获取 VM 性能数据

GET vmstats://{vm_name}

📚 详细文档

配置说明

配置参数详情

安全建议

⚠️ 重要提示

不同环境下需要注意不同的安全配置。

💡 使用建议

• 生产环境：使用有效的 SSL 证书，启用 API 密钥认证，设置适当的日志级别，限制 API 访问范围。
• 测试环境：设置 insecure: true 以跳过 SSL 验证，使用更详细的日志级别（DEBUG）。

📄 许可证

本项目采用 MIT License。

贡献

欢迎提出问题和拉取请求！

变更记录

v0.1

• 初始版本发布

知识产权声明

本项目遵守 MIT 许可证，具体内容请参考 LICENSE 文件。

注意：此文档是根据原始内容重新编写的，并未直接从源代码生成。如需引用，请参考官方文档或源代码。