RbVmomi 技术文档

本文档旨在帮助用户安装、使用及深入了解 RbVmomi 项目。以下是项目的安装指南、使用说明以及 API 使用文档。

1. 安装指南

要安装 RbVmomi，请运行以下命令：

gem install rbvmomi

2. 项目使用说明

RbVmomi 是一个 Ruby 接口，用于访问 vSphere API。您可以使用它来管理 ESX 和 vCenter 服务器。以下是一个简单的示例，展示如何使用 RbVmomi 启动一个虚拟机：

require 'rbvmomi'

vim = RbVmomi::VIM.connect(host: 'foo', user: 'bar', password: 'baz')
dc = vim.serviceInstance.find_datacenter('my_datacenter') || fail('数据中心未找到')
vm = dc.find_vm('my_vm') || fail('虚拟机未找到')
vm.PowerOnVM_Task.wait_for_completion

如果您想使用标准的 API 调用，可以使用以下代码：

require 'rbvmomi'

vim = RbVmomi::VIM.connect(host: 'foo', user: 'bar', password: 'baz')
root_folder = vim.serviceInstance.content.rootFolder
dc = root_folder.childEntity.grep(RbVmomi::VIM::Datacenter).find { |x| x.name == 'my_datacenter' } || fail('数据中心未找到')
vm = dc.vmFolder.childEntity.grep(RbVmomi::VIM::VirtualMachine).find { |x| x.name == 'my_vm' } || fail('虚拟机未找到')
task = vm.PowerOnVM_Task
filter = vim.propertyCollector.CreateFilter(
  spec: {
    propSet: [{ type: 'Task', all: false, pathSet: ['info.state']}],
    objectSet: [{ obj: task }]
  },
  partialUpdates: false
)
ver = ''
loop do
  result = vim.propertyCollector.WaitForUpdates(version: ver)
  ver = result.version
  break if ['success', 'error'].member?(task.info.state)
end
filter.DestroyPropertyFilter
raise(task.info.error) if task.info.state == 'error'

3. 项目 API 使用文档

RbVmomi 的所有类、方法和参数名称均与官方文档一致。属性通过访问器方法公开。数据对象类型通常可以从上下文中推断，因此您可以使用哈希代替。枚举值仅为字符串。

项目中的示例代码位于 examples/ 目录中。此外，项目还包含一组用于 Optimist 的辅助方法，以加速命令行应用程序的开发。

如果连接到的主机上没有安装受信任的 SSL 证书，您将遇到 OpenSSL::SSL::SSLError "证书验证失败" 的错误。您可以通过使用 :insecure 选项来解决此问题：

RbVmomi::VIM.connect(host: 'foo', user: 'bar', password: 'baz', :insecure => true)

4. 项目安装方式

RbVmomi 的安装方式如前所述，通过 Ruby 的 gem 包管理器进行安装：

gem install rbvmomi

以上就是 RbVmomi 的技术文档，希望对您的使用有所帮助。如果您有任何问题或建议，请随时提出。