关键词搜索

源码搜索 ×
×

使用VMware VSphere WebService SDK进行开发 （七）——获取数据中心、集群、主机、虚拟机的目录结构

发布2015-11-18浏览7800次

详情内容

欢迎支持笔者新作：《深入理解Kafka:核心设计与实践原理》和《RabbitMQ实战指南》，同时欢迎关注笔者的微信公众号：朱小厮的博客。

欢迎跳转到本文的原文链接：https://honeypps.com/backend/vmware-vsphere-webservice-sdk-directory/

 

在实际应用中，需要显示出数据中心（Datacenter）、集群（ClusterComputeResource）、主机（HostSystem）、虚拟机(VirtualMachine)之间的目录关系。这里忽略VAPP以及APP。

正所谓无图无真相，先展示一张vSphere Client上的截图，以便形象的描述本文所要呈现的内容。

左边的目录树形象的展示了数据中心（Datacenter）、集群（ClusterComputeResource）、主机（HostSystem）、虚拟机(VirtualMachine)之间的目录关系。但是如何通过vSphere Webservice SDK进行获取相应的信息呢?

首先罗列本文所要展示的几个方法：

 

1. 根据主机名获取虚拟机的名称列表
public static List<String> getVmNameListByHostName(String hostName) throws Exception
2. 根据集群名获取主机的名称列表
public static List<String> getHostNameListByClusterName(String clusterName) throws Exception
3. 根据集群名获取虚拟机的名称列表
public static List<String> getVmNameListByClusterName(String clusterName) throws Exception
4. 根据数据中心名获取主机名称列表
public static List<String> getHostNameListByDCName(String dcName) throws Exception
5. 根据数据中心名获取虚拟机名称列表
public static List<String> getVmNameListByDCName(String dcName) throws Exception
6. 根据数据中心名称获取集群（ClusterComputeResource）列表
public static List<String> getClusterNameListByDCName(String dcName) throws Exception

首先根据主机名获取虚拟机的名称列表，这个比较简单，因为HostSystem有一个属性就是vm,关系一目了然。

根据主机名称遍历，获取匹配主机名称的记录，根据vm的属性名获取虚拟机的ArrayOfManagedObjectReference对象，然后通过：

List<ManagedObjectReference> vmTempList = ((ArrayOfManagedObjectReference)dp.getVal()).getManagedObjectReference();

获取每一个虚拟机的对象，最后根据虚拟机对象获得相应的名称。

同样，根据集群名获取主机名也是相同的。

下面展示出关键代码（所涉及的调用的方法如果未展示出来，可参考前面6篇同系列的博文，在其中会找到，如果真是本人疏忽遗漏，可在下方评论，我会尽快补上）：

 

  1. 	private static List<String> getNameListByName(String paraName, String paraObject, String paraProperty) throws Exception
  2. 	{
  3. 		List<String> list = new ArrayList<String>();
  4. 		
  5. 		RetrieveResult props = getRetrieveResultObjectWithProperty(paraObject, paraProperty);
  6. 		List<ManagedObjectReference> vmList = null;
  7. 		
  8. 		if (props != null)
  9. 		{
  10. 			Boolean flag = false;
  11. 			if (paraProperty.compareToIgnoreCase("name") < 0)
  12. 			{
  13. 				for (ObjectContent oc : props.getObjects())
  14. 				{
  15. 					if (flag == true)
  16. 					{
  17. 						break;
  18. 					}
  19. 					List<ManagedObjectReference> vmTempList = null;
  20. 					String path = null;
  21. 					List<DynamicProperty> dps = oc.getPropSet();
  22.  
  23. 					if (dps != null)
  24. 					{
  25. 						for (DynamicProperty dp : dps)
  26. 						{
  27. 							path = dp.getName();
  28. 							
  29. 							if (path.equalsIgnoreCase(paraProperty))
  30. 							{
  31. 								vmTempList = ((ArrayOfManagedObjectReference)dp.getVal()).getManagedObjectReference();
  32. 							}
  33. 							if (path.equalsIgnoreCase("name"))
  34. 							{
  35. 								String value = (String) dp.getVal();
  36. 								if (value.equals(paraName))
  37. 								{
  38. 									flag = true;
  39. 									vmList = vmTempList;
  40. 									break;
  41. 								}
  42. 							}
  43. 						}
  44. 					}
  45. 				}
  46. 			}
  47. 			else
  48. 			{
  49. 				for (ObjectContent oc : props.getObjects())
  50. 				{
  51. 					if (flag == true)
  52. 					{
  53. 						break;
  54. 					}
  55. 					String path = null;
  56. 					List<DynamicProperty> dps = oc.getPropSet();
  57.  
  58. 					if (dps != null)
  59. 					{
  60. 						for (DynamicProperty dp : dps)
  61. 						{
  62. 							path = dp.getName();
  63. 							if (path.equalsIgnoreCase("name"))
  64. 							{
  65. 								String value = (String) dp.getVal();
  66. 								if (value.equals(paraName))
  67. 								{
  68. 									flag = true;
  69. 								}
  70. 							}
  71. 							if (path.equalsIgnoreCase(paraProperty))
  72. 							{
  73. 								List<ManagedObjectReference> vmTempList = ((ArrayOfManagedObjectReference)dp.getVal()).getManagedObjectReference();
  74. 								if (flag == true)
  75. 								{
  76. 									vmList = vmTempList;
  77. 									break;
  78. 								}
  79. 							}
  80. 						}
  81. 					}
  82. 				}
  83. 			}
  84. 		}
  85. 		
  86. 		if(vmList != null)
  87. 		{
  88. 			for(ManagedObjectReference mor:vmList)
  89. 			{
  90. 				String objectName = getObjectName(mor);
  91. 				if(objectName != null)
  92. 				{
  93. 					list.add(objectName);
  94. 				}
  95. 			}
  96. 		}
  97. 		
  98. 		return list;
  99. 	}
  100. 	
  101. 	public static List<String> getVmNameListByHostName(String hostName) throws Exception
  102. 	{
  103. 		return getNameListByName(hostName,"HostSystem","vm");
  104. 	}
  105. 	
  106. 	public static List<String> getHostNameListByClusterName(String clusterName) throws Exception
  107. 	{
  108. 		return getNameListByName(clusterName,"ComputeResource","host");
  109. 	}


在集群(ComputeResource)中没有像在HostSystem中有类似vm的虚拟机属性，但是我们可以根据集群获得主机，主机获得虚拟机的方式，获得一个虚拟机的列表，代码如下：

 

 

  1. 	public static List<String> getVmNameListByClusterName(String clusterName) throws Exception
  2. 	{
  3. 		List<String> ansList = new ArrayList<String>();
  4. 		
  5. 		List<String> hostList = getNameListByName(clusterName,"ComputeResource","host");
  6. 		if(hostList != null)
  7. 		{
  8. 			for(String hostName : hostList)
  9. 			{
  10. 				List<String> vmList = null;
  11. 				if(hostName != null)
  12. 				{
  13. 					vmList = getVmNameListByHostName(hostName);
  14. 				}
  15. 				if(vmList != null)
  16. 				{
  17. 					for(String vmName : vmList)
  18. 					{
  19. 						if(vmName != null)
  20. 						{
  21. 							ansList.add(vmName);
  22. 						}
  23. 					}
  24. 				}
  25. 			}
  26. 		}
  27.  
  28. 		return ansList;
  29. 	}


接下去，通过数据中心（Datacenter）获取集群、主机、虚拟机的列表就比较绕了。首先看一下Datacenter的api：

 

我们可以发现其中有hostFolder,vmFolder的属性，hostFolder对应的是集群和主机，而vmFolder对应的是虚拟机，所以这里我们可以先通过数据中心的名称获取其对应的hostFolder以及vmFolder的对象，然后通过遍历这些对象多去相应的关键属性。对于如何遍历对象，相信看过我前面几篇博文的朋友应该了解了，关键理解这幅图：

好了，直接上代码，希望各位朋友能够很快理解。

 

  1. 	private static TraversalSpec getHostFolderTraversalSpec()
  2. 	{
  3. 		SelectionSpec ss = new SelectionSpec();
  4. 		ss.setName("VisitFolders");
  5.  
  6. 		TraversalSpec computeResourceToHostSystem = new TraversalSpec();
  7. 		computeResourceToHostSystem.setName("computeResourceToHostSystem");
  8. 		computeResourceToHostSystem.setType("ComputeResource");
  9. 		computeResourceToHostSystem.setPath("host");
  10. 		computeResourceToHostSystem.setSkip(false);
  11. 		computeResourceToHostSystem.getSelectSet().add(ss);
  12.  
  13. 		TraversalSpec hostFolderToComputeResource = new TraversalSpec();
  14. 		hostFolderToComputeResource.setName("hostFolderToComputeResource");
  15. 		hostFolderToComputeResource.setType("Folder");
  16. 		hostFolderToComputeResource.setPath("childEntity");
  17. 		hostFolderToComputeResource.setSkip(false);
  18. 		hostFolderToComputeResource.getSelectSet().add(ss);
  19.  
  20. 		TraversalSpec traversalSpec = new TraversalSpec();
  21. 		traversalSpec.setName("VisitFolders");
  22. 		traversalSpec.setType("Folder");
  23. 		traversalSpec.setPath("childEntity");
  24. 		traversalSpec.setSkip(false);
  25.  
  26. 		List<SelectionSpec> sSpecArr = new ArrayList<SelectionSpec>();
  27. 		sSpecArr.add(ss);
  28. 		sSpecArr.add(hostFolderToComputeResource);
  29. 		sSpecArr.add(computeResourceToHostSystem);
  30. 		traversalSpec.getSelectSet().addAll(sSpecArr);
  31. 		
  32. 		return traversalSpec;
  33. 	}
  34. 	
  35. 	private static TraversalSpec getHostFolderOfComputeResourceTraversalSpec()
  36. 	{
  37. 		SelectionSpec ss = new SelectionSpec();
  38. 		ss.setName("VisitFolders");
  39.  
  40. 		TraversalSpec hostFolderToComputeResource = new TraversalSpec();
  41. 		hostFolderToComputeResource.setName("hostFolderToComputeResource");
  42. 		hostFolderToComputeResource.setType("Folder");
  43. 		hostFolderToComputeResource.setPath("childEntity");
  44. 		hostFolderToComputeResource.setSkip(false);
  45. 		hostFolderToComputeResource.getSelectSet().add(ss);
  46.  
  47. 		TraversalSpec traversalSpec = new TraversalSpec();
  48. 		traversalSpec.setName("VisitFolders");
  49. 		traversalSpec.setType("Folder");
  50. 		traversalSpec.setPath("childEntity");
  51. 		traversalSpec.setSkip(false);
  52.  
  53. 		List<SelectionSpec> sSpecArr = new ArrayList<SelectionSpec>();
  54. 		sSpecArr.add(ss);
  55. 		sSpecArr.add(hostFolderToComputeResource);
  56. 		traversalSpec.getSelectSet().addAll(sSpecArr);
  57. 		
  58. 		return traversalSpec;
  59. 	}
  60. 	
  61. 	private static TraversalSpec getVmFolderTraversalSpec()
  62. 	{
  63. 		TraversalSpec vAppToVM = new TraversalSpec();
  64. 		vAppToVM.setName("vAppToVM");
  65. 		vAppToVM.setType("VirtualApp");
  66. 		vAppToVM.setPath("vm");
  67.  
  68. 		TraversalSpec vAppToVApp = new TraversalSpec();
  69. 		vAppToVApp.setName("vAppToVApp");
  70. 		vAppToVApp.setType("VirtualApp");
  71. 		vAppToVApp.setPath("resourcePool");
  72.  
  73. 		SelectionSpec vAppRecursion = new SelectionSpec();
  74. 		vAppRecursion.setName("vAppToVApp");
  75. 		SelectionSpec vmInVApp = new SelectionSpec();
  76. 		vmInVApp.setName("vAppToVM");
  77. 		List<SelectionSpec> vAppToVMSS = new ArrayList<SelectionSpec>();
  78. 		vAppToVMSS.add(vAppRecursion);
  79. 		vAppToVMSS.add(vmInVApp);
  80. 		vAppToVApp.getSelectSet().addAll(vAppToVMSS);
  81.  
  82. 		SelectionSpec sSpec = new SelectionSpec();
  83. 		sSpec.setName("VisitFolders");
  84.  
  85. 		TraversalSpec traversalSpec = new TraversalSpec();
  86. 		traversalSpec.setName("VisitFolders");
  87. 		traversalSpec.setType("Folder");
  88. 		traversalSpec.setPath("childEntity");
  89. 		traversalSpec.setSkip(false);
  90. 		List<SelectionSpec> sSpecArr = new ArrayList<SelectionSpec>();
  91. 		sSpecArr.add(sSpec);
  92. 		sSpecArr.add(vAppToVM);
  93. 		sSpecArr.add(vAppToVApp);
  94. 		traversalSpec.getSelectSet().addAll(sSpecArr);
  95. 		return traversalSpec;
  96. 	}
  97. 	
  98. 	private static ManagedObjectReference getHostFolderObjectByDcName(String dcName) throws Exception
  99. 	{
  100. 		ManagedObjectReference hostFolder  = null;
  101. 		RetrieveResult props = getRetrieveResultObjectWithProperty("Datacenter", "hostFolder");
  102. 		if(props != null)
  103. 		{
  104. 			Boolean flag = false;
  105. 			for (ObjectContent oc : props.getObjects())
  106. 			{
  107. 				if (flag == true)
  108. 				{
  109. 					break;
  110. 				}
  111. 				String path = null;
  112. 				List<DynamicProperty> dps = oc.getPropSet();
  113. 				ManagedObjectReference mor = null;
  114. 				if (dps != null)
  115. 				{
  116. 					for (DynamicProperty dp : dps)
  117. 					{
  118. 						path = dp.getName();
  119. 						if (path.equalsIgnoreCase("hostFolder"))
  120. 						{
  121. 							mor = (ManagedObjectReference)dp.getVal();
  122. 						}
  123. 						if (path.equalsIgnoreCase("name"))
  124. 						{
  125. 							String value = (String) dp.getVal();
  126. 							if (value.equals(dcName))
  127. 							{
  128. 								flag = true;
  129. 								hostFolder = mor;
  130. 								break;
  131. 							}
  132. 						}
  133. 					}
  134. 				}
  135. 			}
  136. 		}
  137. 		return hostFolder;
  138. 	}
  139. 	
  140. 	private static ManagedObjectReference getVmFolderObjectByDcName(String dcName) throws Exception
  141. 	{
  142. 		ManagedObjectReference vmFolder = null;
  143. 		RetrieveResult props = getRetrieveResultObjectWithProperty("Datacenter", "vmFolder");
  144. 		if(props != null)
  145. 		{
  146. 			Boolean flag = false;
  147. 			for (ObjectContent oc : props.getObjects())
  148. 			{
  149. 				if (flag == true)
  150. 				{
  151. 					break;
  152. 				}
  153. 				String path = null;
  154. 				List<DynamicProperty> dps = oc.getPropSet();
  155. 				ManagedObjectReference mor = null;
  156. 				if (dps != null)
  157. 				{
  158. 					for (DynamicProperty dp : dps)
  159. 					{
  160. 						path = dp.getName();
  161. 						if (path.equalsIgnoreCase("name"))
  162. 						{
  163. 							String value = (String) dp.getVal();
  164. 							if (value.equals(dcName))
  165. 							{
  166. 								flag = true;
  167. 							}
  168. 						}
  169. 						if (path.equalsIgnoreCase("vmFolder"))
  170. 						{
  171. 							mor = (ManagedObjectReference)dp.getVal();
  172. 							if(flag == true)
  173. 							{
  174. 								vmFolder = mor;
  175. 								break;
  176. 							}
  177. 						}
  178. 					}
  179. 				}
  180. 			}
  181. 		}
  182. 		return vmFolder;
  183. 	}
  184. 	
  185. 	private static List<String> getHostNamesByHostFolder(ManagedObjectReference hostFolder) throws Exception
  186. 	{
  187. 		List<String> list = new ArrayList<String>();
  188. 		
  189. 		TraversalSpec tSpec = getHostFolderTraversalSpec();
  190. 		PropertySpec propertySpec = new PropertySpec();
  191. 		propertySpec.setAll(Boolean.FALSE);
  192. 		propertySpec.getPathSet().add("name");
  193. 		propertySpec.setType("HostSystem");
  194. 		
  195. 		ObjectSpec objectSpec = new ObjectSpec();
  196. 		objectSpec.setObj(hostFolder);
  197. 		objectSpec.setSkip(Boolean.TRUE);
  198. 		objectSpec.getSelectSet().add(tSpec);
  199.  
  200. 		PropertyFilterSpec propertyFilterSpec = new PropertyFilterSpec();
  201. 		propertyFilterSpec.getPropSet().add(propertySpec);
  202. 		propertyFilterSpec.getObjectSet().add(objectSpec);
  203. 		
  204. 		List<PropertyFilterSpec> listpfs = new ArrayList<PropertyFilterSpec>(1);
  205. 		listpfs.add(propertyFilterSpec);
  206. 		List<ObjectContent> listobjcont = retrievePropertiesAllObjects(listpfs);
  207.  
  208. 		if (listobjcont != null)
  209. 		{
  210. 			for (ObjectContent oc : listobjcont)
  211. 			{
  212. 				String hostnm = null;
  213. 				List<DynamicProperty> listDynamicProps = oc.getPropSet();
  214. 				DynamicProperty[] dps = listDynamicProps.toArray(new DynamicProperty[listDynamicProps.size()]);
  215. 				if (dps != null)
  216. 				{
  217. 					for (DynamicProperty dp : dps)
  218. 					{
  219. 						hostnm = (String) dp.getVal();
  220. 						if (hostnm != null)
  221. 						{
  222. 							list.add(hostnm);
  223. 						}
  224. 					}
  225. 				}
  226. 			}
  227. 		}
  228. 		
  229. 		return list;
  230. 	}
  231. 	
  232. 	private static List<String> getClusterNamesByHostFolder(ManagedObjectReference hostFolder) throws Exception
  233. 	{
  234. 		List<String> list = new ArrayList<String>();
  235. 		
  236. 		TraversalSpec tSpec = getHostFolderOfComputeResourceTraversalSpec();
  237. 		PropertySpec propertySpec = new PropertySpec();
  238. 		propertySpec.setAll(Boolean.FALSE);
  239. 		propertySpec.getPathSet().add("name");
  240. 		propertySpec.setType("ClusterComputeResource");
  241. 		
  242. 		ObjectSpec objectSpec = new ObjectSpec();
  243. 		objectSpec.setObj(hostFolder);
  244. 		objectSpec.setSkip(Boolean.TRUE);
  245. 		objectSpec.getSelectSet().add(tSpec);
  246.  
  247. 		PropertyFilterSpec propertyFilterSpec = new PropertyFilterSpec();
  248. 		propertyFilterSpec.getPropSet().add(propertySpec);
  249. 		propertyFilterSpec.getObjectSet().add(objectSpec);
  250. 		
  251. 		List<PropertyFilterSpec> listpfs = new ArrayList<PropertyFilterSpec>(1);
  252. 		listpfs.add(propertyFilterSpec);
  253. 		List<ObjectContent> listobjcont = retrievePropertiesAllObjects(listpfs);
  254.  
  255. 		if (listobjcont != null)
  256. 		{
  257. 			for (ObjectContent oc : listobjcont)
  258. 			{
  259. 				String hostnm = null;
  260. 				List<DynamicProperty> listDynamicProps = oc.getPropSet();
  261. 				DynamicProperty[] dps = listDynamicProps.toArray(new DynamicProperty[listDynamicProps.size()]);
  262. 				if (dps != null)
  263. 				{
  264. 					for (DynamicProperty dp : dps)
  265. 					{
  266. 						hostnm = (String) dp.getVal();
  267. 						if (hostnm != null)
  268. 						{
  269. 							list.add(hostnm);
  270. 						}
  271. 					}
  272. 				}
  273. 			}
  274. 		}
  275. 		
  276. 		return list;
  277. 	}
  278. 	
  279. 	private static List<String> getVmNamesByVmFolder(ManagedObjectReference vmFolder) throws Exception
  280. 	{
  281. 		List<String> list = new ArrayList<String>();
  282. 		
  283. 		TraversalSpec tSpec = getVmFolderTraversalSpec();
  284. 		PropertySpec propertySpec = new PropertySpec();
  285. 		propertySpec.setAll(Boolean.FALSE);
  286. 		propertySpec.getPathSet().add("name");
  287. 		propertySpec.setType("VirtualMachine");
  288. 		
  289. 		ObjectSpec objectSpec = new ObjectSpec();
  290. 		objectSpec.setObj(vmFolder);
  291. 		objectSpec.setSkip(Boolean.TRUE);
  292. 		objectSpec.getSelectSet().add(tSpec);
  293.  
  294. 		PropertyFilterSpec propertyFilterSpec = new PropertyFilterSpec();
  295. 		propertyFilterSpec.getPropSet().add(propertySpec);
  296. 		propertyFilterSpec.getObjectSet().add(objectSpec);
  297. 		
  298. 		List<PropertyFilterSpec> listpfs = new ArrayList<PropertyFilterSpec>(1);
  299. 		listpfs.add(propertyFilterSpec);
  300. 		List<ObjectContent> listobjcont = retrievePropertiesAllObjects(listpfs);
  301.  
  302. 		if (listobjcont != null)
  303. 		{
  304. 			for (ObjectContent oc : listobjcont)
  305. 			{
  306. 				String vmName = null;
  307. 				List<DynamicProperty> listDynamicProps = oc.getPropSet();
  308. 				DynamicProperty[] dps = listDynamicProps.toArray(new DynamicProperty[listDynamicProps.size()]);
  309. 				if (dps != null)
  310. 				{
  311. 					for (DynamicProperty dp : dps)
  312. 					{
  313. 						vmName = (String) dp.getVal();
  314. 						if (vmName != null)
  315. 						{
  316. 							list.add(vmName);
  317. 						}
  318. 					}
  319. 				}
  320. 			}
  321. 		}
  322. 		
  323. 		return list;
  324. 	}
  325. 	
  326. 	public static List<String> getHostNameListByDCName(String dcName) throws Exception
  327. 	{
  328. 		ManagedObjectReference hostFolder = getHostFolderObjectByDcName(dcName);
  329. 		List<String> list = null;
  330. 		if(hostFolder != null)
  331. 		{
  332. 			list = getHostNamesByHostFolder(hostFolder);			
  333. 		}
  334. 		return list;
  335. 	}
  336. 	
  337. 	public static List<String> getVmNameListByDCName(String dcName) throws Exception
  338. 	{
  339. 		List<String> list = null;
  340. 		ManagedObjectReference vmFolder = getVmFolderObjectByDcName(dcName);
  341. 		if(vmFolder != null)
  342. 		{
  343. 			list = getVmNamesByVmFolder(vmFolder);			
  344. 		}
  345. 		
  346. 		return list;
  347. 	}
  348. 	
  349. 	public static List<String> getClusterNameListByDCName(String dcName) throws Exception
  350. 	{
  351. 		ManagedObjectReference hostFolder = getHostFolderObjectByDcName(dcName);
  352. 		List<String> list = null;
  353. 		if(hostFolder != null)
  354. 		{
  355. 			list = getClusterNamesByHostFolder(hostFolder);			
  356. 		}
  357. 		return list;
  358. 	}


最后三个以public static修饰的方法就是通过数据中心的名称获取集群、主机、虚拟机的名称列表的方法。

 

如有疑问，欢迎提出。本文展示的代码都经过真实环境运行并投入使用中。

 

欢迎跳转到本文的原文链接：https://honeypps.com/backend/vmware-vsphere-webservice-sdk-directory/

欢迎支持笔者新作：《深入理解Kafka:核心设计与实践原理》和《RabbitMQ实战指南》，同时欢迎关注笔者的微信公众号：朱小厮的博客。

相关技术文章

最新源码

下载排行榜
点击QQ咨询
开通会员
返回顶部
×
微信扫码支付 元
微信扫码支付
确定支付下载
请使用微信描二维码支付
×

提示信息

×

选择支付方式

  • 微信支付
  • 支付宝付款
确定支付下载