VMware 虚拟化编程(3) —VMware vSphere Web Service API 解析

本文涉及的产品
应用型负载均衡 ALB,每月750个小时 15LCU
网络型负载均衡 NLB,每月750个小时 15LCU
云解析 DNS,旗舰版 1个月
简介: 目录目录前文列表VMware vSphere Web Services APIVMware vSphere Web Services SDKvSphere WS API 中的托管对象 Managed Object托管对象引用 Managed Object ...

目录

前文列表

VMware 虚拟化编程(1) — VMDK/VDDK/VixDiskLib/VADP 概念简析
VMware 虚拟化编程(2) — 虚拟磁盘文件类型详解

VMware vSphere Web Services API

VMware vSphere Web Services API (vSphere WS API),是官方提供的 ESX/ESXi Host 和 vCenter Server 开发者接口。通过调用 vSphere WS API,开发者能够实现 vSphere Web Client 上所提供的绝大部分管理操作功能,所以熟练使用 vSphere WS API 是面向 VMware 相关编程的必备技能之一。

vSphere WS API 应用了一种基于 Web 服务的编程模型,客户端会生成 Web 服务的 WSDL 网络服务描述语言请求,然后通过 SOAP 简单对象访问协议将请求封装成 XML 格式消息,最后再发送到到服务端。而在 ESX/ESXi Host 或 vCenter Server 端中,则由 vSphere 层负责应答客户端的请求,并返回 SOAP 响应。这是区别于面向对象函数调用的一种编程模型。

VMware vSphere Web Services SDK

摘自官方文档:The VMware vSphere Management SDK is a bundle that contains a set of VMware vSphere SDKs (vSphere Web Services SDK, vSphere Storage Management SDK, vSphere ESX Agent Manager SDK, SSO Client SDK and vSphere Storage Policy SDK) The vSphere Software Development Kits provide all the documentation, libraries, and code examples needed to developers to rapidly build solutions integrated with the industry’s leading virtualization platform.

VMware vSphere Web Services SDK (vSphere WS SDK),是官方提供的标准开发工具,其中包含了 Web Services、Storage Management、ESX Agent Manager、SSO Client、Storage Policy 等多方面编程相关的文档、Lib 库以及示例代码。能够帮助开发者快速搭建 Python、Microsoft C#、Java、C/C++ 的应用端开发环境,并且这些示例代码大部分都是使用 Java 编写的,还单独提供了 JAX-WS 开发框架,可以说是很照顾 Java Developer了。不过奈何我是一位 Pythoner,所以我们后面的所有 Sample 均为 Python 实现。

VMware vSphere Web Services SDK Docs

vSphere WS API 中的托管对象 Managed Object

VMware vSphere API Reference Docs 中记录了大量的托管对象 Managed Object,这些托管对象充当着 API 信息容器的角色,开发者通过处理这些信息容器中的内容来最终实现对 vSphere 系统的操作。

这里写图片描述

每个托管对象都拥有一个唯一专属的句柄(Handle),称为托管对象引用(Managed Object Referenct),简称 moRef。开发者能够通过 moRef + PropertyCollector(获取对象详细属性信息的机制) 的方式来获取一个托管对象的详细状态信息。

下面列出的是五种基本托管对象类型,它们描述了 vSphere 系统的组织结构,其他的托管对象可以看作是这五种基本对象的详细扩展。

  • 目录(Folder)
  • 数据中心(Datacenter)
  • 计算资源(ComputeResource)
  • 资源池(ResourcePool)
  • 虚拟机(VirtualMachine)

托管对象引用 Managed Object References

托管对象引用 moRef 实际上是一个句柄,它就像是一个信息容器的入口,而非容器本身。并且 moRef 具有唯一性,但这种唯一性是取决于你的连接方式的。当你的连接的对象为 ESX/ESXi Host 时,那么 moRef 的命名空间由 ESX/ESXi Host 来维护,这很简单;但如果你的连接对象是 vCenter,并且 vCenter 管理着 ESX/ESXi Host 集群时,moRef 的唯一性就需要由 vCenter 来确保。这就意味着即便是同一个 MO,当你的连接方式不同时,可能会获得不一样的 moRef 唯一值,从而使得后续的操作产生混乱。

官方文档中也明确指出了 A vSphere instance (vCenter or ESXi) tries to keep the moRef for a virtual machine consistent across sessions, however consistency is not guaranteed.,这里是一个坑,要求开发者应该始终贯彻同一种连接方式,并且不建议持久化 moRef。

托管对象属性收集器 PropertyCollector

PropertyCollector 的功能是帮助开发者取得一个托管对象的配置状态信息。PropertyCollector 具有两个非常重要的形参 PropertySpec, ObjectSpec。PropertyCollector 返回的数据是一个 PropertyFilterUpdate 容器类,它包含一个 ObjectSet。

  • ObjectSpec:用于指定自何处查找所需的属性信息。 由于 vSphere 使用目录树的形式来组织配置信息,所以 ObjectSpec 必须描述如何遍历树以获取所需的信息。
  • PropertySpec:用于指定所需获取的属性信息列表。

连接 vCenter 并获取 MO

常见的 Python SDK 有 oslo_vmware 和 pyVmomi 两种,前者是 OpenStack Nova 项目为了纳管 VMware 资源所开发出来的基础通用库,后者则是 VMware 官方提供的 Python SDK。就个人而言会更加偏向在正式项目中使用 pyVmomi,主要原因在于其提供了非常完备的 文档 和许多实用的 Sample 实现,这些都是非常重要的技术选型考量点。

但是,为了更直观方便的辅助理解上述概念,我们这里还是选择使用封装程度较低的 oslo_vmware 结合 IPython CLI 来作为示例。 oslo_vmware 的具体使用细节,请移步《Python Module_oslo.vmware_连接 vCenter》

  • Step 1: 建立连接
In [10]: from oslo_vmware import api
In [11]: from oslo_vmware import vim_util

In [12]: session = api.VMwareAPISession(
   ....:             '192.168.10.105',
   ....:             'administrator@vsphere.local',
   ....:             'Root123.',
   ....:              1,
   ....:              0.1)
  • Step 2:获取你期望的 Managed Object
    其中 HostSystem 就是该托管对象的名字,我们可以自 vSphere WS API 中找到相应的 API 文档。

这里写图片描述

In [15]: hosts = session.invoke_api(
   ....:     vim_util,
   ....:     'get_objects',
   ....:     session.vim,
   ....:     'HostSystem',
   ....:     100)

In [16]: hosts
Out[16]:
(RetrieveResult){
   objects[] =
      (ObjectContent){
         obj =
            (obj){
               value = "host-2068"
               _type = "HostSystem"
            }
         propSet[] =
            (DynamicProperty){
               name = "name"
               val = "192.168.10.103"
            },
      },
 }

In [19]: hosts.objects[0].obj
Out[19]:
(obj){
   value = "host-2068"
   _type = "HostSystem"
 }

这里我们获得了一个 HostSystem Managed Object 的一个句柄也就是 moRef:hosts.objects[0].obj,其中包含了唯一值 host-2068

  • Step3:获取你期望的托管对象中所含有的配置状态信息。
    通过 moRef 结合应用 PropertyCollector 机制,就能得到该托管对象的配置状态信息。我们可以在 API 文档中浏览该托管对象的属性项目。

这里写图片描述

In [26]: host = hosts.objects[0].obj

In [27]: nets = session.invoke_api(vim_util, 'get_object_properties_dict', session.vim,
                                   host, 'config.network.portgroup')

在上述代码中,host 实参就是一个 ObjectSpec,指定了从 moRef host-2068 中查找所需要的信息。而 config.network.portgroup 实参则是 PropertySpec,指定了所需要获取的属性信息。最终获取到 ESXi/ESX Host 192.168.10.103 的网络信息如下:


In [28]: nets
Out[28]:
{config.network.portgroup: (ArrayOfHostPortGroup){
   HostPortGroup[] =
      (HostPortGroup){
         key = "key-vim.host.PortGroup-VM Network"
         port[] =
            (HostPortGroupPort){
               key = "key-vim.host.PortGroup.Port-33554439"
               mac[] =
                  "00:0c:29:de:9b:d6",
               type = "virtualMachine"
            },
            (HostPortGroupPort){
               key = "key-vim.host.PortGroup.Port-33554441"
               mac[] =
                  "00:50:56:9d:6e:09",
               type = "virtualMachine"
            },
            (HostPortGroupPort){
               key = "key-vim.host.PortGroup.Port-33554463"
               mac[] =
                  "00:50:56:9d:4d:69",
               type = "virtualMachine"
            },
         vswitch = "key-vim.host.VirtualSwitch-vSwitch0"
         computedPolicy =
            (HostNetworkPolicy){
               security =
                  (HostNetworkSecurityPolicy){
                     allowPromiscuous = False
                     macChanges = True
                     forgedTransmits = True
                  }
               nicTeaming =
                  (HostNicTeamingPolicy){
                     policy = "loadbalance_srcid"
                     reversePolicy = True
                     notifySwitches = True
                     rollingOrder = False
                     failureCriteria =
                        (HostNicFailureCriteria){
                           checkSpeed = "minimum"
                           speed = 10
                           checkDuplex = False
                           fullDuplex = False
                           checkErrorPercent = False
                           percentage = 0
                           checkBeacon = False
                        }
                     nicOrder =
                        (HostNicOrderPolicy){
                           activeNic[] =
                              "vmnic0",
                        }
                  }
               offloadPolicy =
                  (HostNetOffloadCapabilities){
                     csumOffload = True
                     tcpSegmentation = True
                     zeroCopyXmit = True
                  }
               shapingPolicy =
                  (HostNetworkTrafficShapingPolicy){
                     enabled = False
                  }
            }
         spec =
            (HostPortGroupSpec){
               name = "VM Network"
               vlanId = 0
               vswitchName = "vSwitch0"
               policy =
                  (HostNetworkPolicy){
                     security = ""
                     nicTeaming =
                        (HostNicTeamingPolicy){
                           failureCriteria = ""
                        }
                     offloadPolicy = ""
                     shapingPolicy = ""
                  }
            }
      },
      (HostPortGroup){
         key = "key-vim.host.PortGroup-Management Network"
         port[] =
            (HostPortGroupPort){
               key = "key-vim.host.PortGroup.Port-33554438"
               mac[] =
                  "c8:1f:66:b9:33:32",
               type = "host"
            },
         vswitch = "key-vim.host.VirtualSwitch-vSwitch0"
         computedPolicy =
            (HostNetworkPolicy){
               security =
                  (HostNetworkSecurityPolicy){
                     allowPromiscuous = False
                     macChanges = True
                     forgedTransmits = True
                  }
               nicTeaming =
                  (HostNicTeamingPolicy){
                     policy = "loadbalance_srcid"
                     reversePolicy = True
                     notifySwitches = True
                     rollingOrder = False
                     failureCriteria =
                        (HostNicFailureCriteria){
                           checkSpeed = "minimum"
                           speed = 10
                           checkDuplex = False
                           fullDuplex = False
                           checkErrorPercent = False
                           percentage = 0
                           checkBeacon = False
                        }
                     nicOrder =
                        (HostNicOrderPolicy){
                           activeNic[] =
                              "vmnic0",
                        }
                  }
               offloadPolicy =
                  (HostNetOffloadCapabilities){
                     csumOffload = True
                     tcpSegmentation = True
                     zeroCopyXmit = True
                  }
               shapingPolicy =
                  (HostNetworkTrafficShapingPolicy){
                     enabled = False
                  }
            }
         spec =
            (HostPortGroupSpec){
               name = "Management Network"
               vlanId = 0
               vswitchName = "vSwitch0"
               policy =
                  (HostNetworkPolicy){
                     security = ""
                     nicTeaming =
                        (HostNicTeamingPolicy){
                           policy = "loadbalance_srcid"
                           notifySwitches = True
                           rollingOrder = False
                           failureCriteria =
                              (HostNicFailureCriteria){
                                 checkBeacon = False
                              }
                           nicOrder =
                              (HostNicOrderPolicy){
                                 activeNic[] =
                                    "vmnic0",
                              }
                        }
                     offloadPolicy = ""
                     shapingPolicy = ""
                  }
            }
      },
      (HostPortGroup){
         key = "key-vim.host.PortGroup-iscsi01"
         port[] =
            (HostPortGroupPort){
               key = "key-vim.host.PortGroup.Port-50331656"
               mac[] =
                  "00:50:56:65:ca:28",
               type = "host"
            },
         vswitch = "key-vim.host.VirtualSwitch-vSwitch1"
         computedPolicy =
            (HostNetworkPolicy){
               security =
                  (HostNetworkSecurityPolicy){
                     allowPromiscuous = False
                     macChanges = True
                     forgedTransmits = True
                  }
               nicTeaming =
                  (HostNicTeamingPolicy){
                     policy = "loadbalance_srcid"
                     reversePolicy = True
                     notifySwitches = True
                     rollingOrder = False
                     failureCriteria =
                        (HostNicFailureCriteria){
                           checkSpeed = "minimum"
                           speed = 10
                           checkDuplex = False
                           fullDuplex = False
                           checkErrorPercent = False
                           percentage = 0
                           checkBeacon = False
                        }
                     nicOrder =
                        (HostNicOrderPolicy){
                           activeNic[] =
                              "vmnic1",
                        }
                  }
               offloadPolicy =
                  (HostNetOffloadCapabilities){
                     csumOffload = True
                     tcpSegmentation = True
                     zeroCopyXmit = True
                  }
               shapingPolicy =
                  (HostNetworkTrafficShapingPolicy){
                     enabled = False
                  }
            }
         spec =
            (HostPortGroupSpec){
               name = "iscsi01"
               vlanId = 0
               vswitchName = "vSwitch1"
               policy =
                  (HostNetworkPolicy){
                     security = ""
                     nicTeaming =
                        (HostNicTeamingPolicy){
                           failureCriteria = ""
                        }
                     offloadPolicy = ""
                     shapingPolicy = ""
                  }
            }
      },
      (HostPortGroup){
         key = "key-vim.host.PortGroup-iscsivspg"
         vswitch = "key-vim.host.VirtualSwitch-vSwitch1"
         computedPolicy =
            (HostNetworkPolicy){
               security =
                  (HostNetworkSecurityPolicy){
                     allowPromiscuous = False
                     macChanges = True
                     forgedTransmits = True
                  }
               nicTeaming =
                  (HostNicTeamingPolicy){
                     policy = "loadbalance_srcid"
                     reversePolicy = True
                     notifySwitches = True
                     rollingOrder = False
                     failureCriteria =
                        (HostNicFailureCriteria){
                           checkSpeed = "minimum"
                           speed = 10
                           checkDuplex = False
                           fullDuplex = False
                           checkErrorPercent = False
                           percentage = 0
                           checkBeacon = False
                        }
                     nicOrder =
                        (HostNicOrderPolicy){
                           activeNic[] =
                              "vmnic1",
                        }
                  }
               offloadPolicy =
                  (HostNetOffloadCapabilities){
                     csumOffload = True
                     tcpSegmentation = True
                     zeroCopyXmit = True
                  }
               shapingPolicy =
                  (HostNetworkTrafficShapingPolicy){
                     enabled = False
                  }
            }
         spec =
            (HostPortGroupSpec){
               name = "iscsivspg"
               vlanId = 0
               vswitchName = "vSwitch1"
               policy = ""
            }
      },
      (HostPortGroup){
         key = "key-vim.host.PortGroup-aju-test"
         vswitch = "key-vim.host.VirtualSwitch-vSwitch0"
         computedPolicy =
            (HostNetworkPolicy){
               security =
                  (HostNetworkSecurityPolicy){
                     allowPromiscuous = False
                     macChanges = True
                     forgedTransmits = True
                  }
               nicTeaming =
                  (HostNicTeamingPolicy){
                     policy = "loadbalance_srcid"
                     reversePolicy = True
                     notifySwitches = True
                     rollingOrder = False
                     failureCriteria =
                        (HostNicFailureCriteria){
                           checkSpeed = "minimum"
                           speed = 10
                           checkDuplex = False
                           fullDuplex = False
                           checkErrorPercent = False
                           percentage = 0
                           checkBeacon = False
                        }
                     nicOrder =
                        (HostNicOrderPolicy){
                           activeNic[] =
                              "vmnic0",
                        }
                  }
               offloadPolicy =
                  (HostNetOffloadCapabilities){
                     csumOffload = True
                     tcpSegmentation = True
                     zeroCopyXmit = True
                  }
               shapingPolicy =
                  (HostNetworkTrafficShapingPolicy){
                     enabled = False
                  }
            }
         spec =
            (HostPortGroupSpec){
               name = "aju-test"
               vlanId = 0
               vswitchName = "vSwitch0"
               policy = ""
            }
      },
 }}

最后

最后需要注意的是,这里使用 oslo_vmware 是为了让示例更加贴近所提到的概念。而这些概念在实际的生成中完全是可以透明的,只需要浏览 pyVmomi 所提供的文档,并熟练掌握其使用技巧,也能够很好的完成实现。

相关文章
|
2月前
|
存储 网络安全 虚拟化
虚拟化数据恢复—VMware ESX Server数据恢复案例
虚拟化数据恢复环境: 某企业信息管理平台, 几台VMware ESX Server主机共享一台存储设备,大约有几十台虚拟机。 虚拟化故障&原因: Vcenter报告虚拟磁盘丢失。管理员通过ssh远程到ESX中执行fdisk -l命令查看磁盘,发现STORAGE已经没有分区表了。重启所有设备后,ESX SERVER均无法连接到存储设备中的STORAGE。
|
1月前
|
存储 SQL 数据库
虚拟化数据恢复—Vmware虚拟机误还原快照的数据恢复案例
虚拟化数据恢复环境: 一台虚拟机从物理机迁移到ESXI虚拟化平台,迁移完成后做了一个快照。虚拟机上运行了一个SQL Server数据库,记录了数年的数据。 ESXI虚拟化平台上有数十台虚拟机,EXSI虚拟化平台连接了一台EVA存储,所有的虚拟机都存放在EVA存储上。 虚拟化故障: 工组人员误操作将数年前迁移完成后做的快照还原了,也就意味着虚拟机状态还原到数年前,近几年数据都被删除了。 还原快照相当于删除数据,意味着部分存储空间会被释放。为了不让这部分释放的空间被重用,需要将连接到这台存储的所有虚拟机都关掉,需要将不能长时间宕机的虚拟机迁移到别的EXSI虚拟化平台上。
108 50
|
4月前
|
存储 监控 固态存储
【vSAN分布式存储服务器数据恢复】VMware vSphere vSAN 分布式存储虚拟化平台VMDK文件1KB问题数据恢复案例
在一例vSAN分布式存储故障中,因替换故障闪存盘后磁盘组失效,一台采用RAID0策略且未使用置备的虚拟机VMDK文件受损,仅余1KB大小。经分析发现,该VMDK文件与内部虚拟对象关联失效导致。恢复方案包括定位虚拟对象及组件的具体物理位置,解析分配空间,并手动重组RAID0结构以恢复数据。此案例强调了深入理解vSAN分布式存储机制的重要性,以及定制化数据恢复方案的有效性。
107 5
|
4月前
|
安全 Java API
告别繁琐编码,拥抱Java 8新特性:Stream API与Optional类助你高效编程,成就卓越开发者!
【8月更文挑战第29天】Java 8为开发者引入了多项新特性,其中Stream API和Optional类尤其值得关注。Stream API对集合操作进行了高级抽象,支持声明式的数据处理,避免了显式循环代码的编写;而Optional类则作为非空值的容器,有效减少了空指针异常的风险。通过几个实战示例,我们展示了如何利用Stream API进行过滤与转换操作,以及如何借助Optional类安全地处理可能为null的数据,从而使代码更加简洁和健壮。
129 0
|
1月前
|
存储 网络安全 虚拟化
虚拟化数据恢复—VMware ESX SERVER数据恢复案例
虚拟化数据恢复环境&故障: 某单位信息管理平台,数台VMware ESX SERVER共享一台某品牌DS4100存储。 vc报告虚拟磁盘丢失,管理员ssh到ESX中执行fdisk -l查看磁盘,发现STORAGE中的分区表不见了。重启所有设备后,ESX SERVER均无法连接到DS4100存储中的STORAGE。
|
3月前
|
网络协议 API Windows
MASM32编程调用 API函数RtlIpv6AddressToString,windows 10 容易,Windows 7 折腾
MASM32编程调用 API函数RtlIpv6AddressToString,windows 10 容易,Windows 7 折腾
|
3月前
|
存储 SQL 数据挖掘
虚拟化数据恢复—VMware虚拟机vmdk文件被误删除的数据恢复案例
虚拟化数据恢复环境: 某品牌服务器(部署VMware EXSI虚拟机)+同品牌存储(存放虚拟机文件)。 虚拟化故障: 意外断电导致服务器上某台虚拟机无法正常启动。查看虚拟机配置文件发现这台故障虚拟机除了磁盘文件以外其他配置文件全部丢失,xxx-flat.vmdk磁盘文件和xxx-000001-delta.vmdk快照文件还在。管理员联系VMware工程师寻求帮助。VMware工程师尝试新建一个虚拟机来解决故障,但发现ESXi存储空间不足。于是将故障虚拟机下的xxx-flat.vmdk磁盘文件删除,然后重建一个虚拟机并且分配固定大小的虚拟磁盘。
|
2月前
|
IDE API 定位技术
Python--API编程:IP地址翻译成实际的物理地址
Python--API编程:IP地址翻译成实际的物理地址
63 0
|
3月前
|
KVM 虚拟化
计算虚拟化之CPU——qemu解析
【9月更文挑战10天】本文介绍了QEMU命令行参数的解析过程及其在KVM虚拟化中的应用。展示了QEMU通过多个`qemu_add_opts`函数调用处理不同类型设备和配置选项的方式,并附上了OpenStack生成的一个复杂KVM参数实例。
|
4月前
|
存储 安全 Linux
在Linux中,如何使用VMware和VirtualBox进行虚拟化?
在Linux中,如何使用VMware和VirtualBox进行虚拟化?

推荐镜像

更多