Breeze.1978@aliyun.com
vSphere Web Services SDK 文档
文件状态:
文件标识:
[ ] 草稿
当前版本: 1.0
[√ ] 正式发布
作 者: 尹哲
[ ] 正在修改
完成日期:
版本/状态
作者
参与者
起止日期
备注
2012/12/13-2013/07/26
1.0
尹哲
1 / 241
Breeze.1978@aliyun.com
目录
1.1
1.2
1、VMware vSphere and vSphere 管理 APIs: .............................................................................. 9
虚拟化和 VMware vSphere 组件 ............................................................................. 9
vSphere 开发工具 .................................................................................................... 9
1.2.1 vSphere Web Services SDK .................................................................................. 9
1.2.2 CIM APIs ............................................................................................................ 10
1.2.3 vSphere SDK for Perl .......................................................................................... 10
1.2.4 vSphere PowerCLI .............................................................................................. 10
1.2.5 VIX API .............................................................................................................. 10
1.3 SDK 安装 .......................................................................................................................... 11
1.4 SDK 例子 .......................................................................................................................... 11
2、vSphere API 编程模型 ............................................................................................................. 11
2.1 vSphere 客户端-服务端架构 .......................................................................................... 12
2.2 vShpere API 作为 Web Service ........................................................................................ 13
2.2.1 WSDL 文件 and the Client-Side 代理接口 ........................................................ 13
2.2.2 网络访问 vShpere Web Service .......................................................................... 14
2.2.3 Language-Specific Classes and Methods ............................................................ 14
2.3.4 影射 XML 数据类型到 Java and C# 数据类型 ................................................ 15
2.3 访问 managed 对象 ......................................................................................................... 15
2.4 访问 vSphere Server 数据 ............................................................................................... 16
2.4.1 检索服务器信息 ................................................................................................... 16
2.4.2 Working with Data Structures ................................................................................ 17
2.4.3 访问属性值 ........................................................................................................... 17
2.4.4 未设置的可选属性 ............................................................................................... 20
2.4.5 属性名称和路径中的换码符 ............................................................................... 21
3、客户端应用 ............................................................................................................................... 21
3.1 基本客户端应用功能 ...................................................................................................... 21
3.2 一个 Java 例子应用概况 ................................................................................................. 22
3.2.1 Java 客户端例程 .................................................................................................... 23
3.3 Web Server Session 记号 .................................................................................................. 26
3.3.1 使用 JAX-WS 访问 HTTP Endpoint .................................................................. 27
3.3.2 访问 vSphere Server ............................................................................................. 29
3.3.3 关闭连接 ............................................................................................................... 30
3.3.4 Using the Java Samples as Reference .................................................................... 30
3.4 使用 Axis Bindings .......................................................................................................... 32
3.5 vSphere API 多版本 ......................................................................................................... 33
3.6 Server 支持确定 API 版本 .............................................................................................. 34
4、数据中心清单 ........................................................................................................................... 34
4.1 清单概况 .......................................................................................................................... 35
4.1 清单层次和 and ServiceInstance ..................................................................................... 35
4.1.1 层次中的文件夹 ................................................................................................... 36
4.2 ESX/ESXi 清单层次 ............................................................................................... 36
4.2 访问 Accessing Inventory Objects ................................................................................... 37
2 / 241
Breeze.1978@aliyun.com
4.3 创建清单对象 .................................................................................................................. 38
4.4 清单权利权限需求 .......................................................................................................... 39
4.4.1 权限 ....................................................................................................................... 39
4.4.2 许可 ....................................................................................................................... 39
4.5 被管理的和独立的 ESX/ESXi 主机............................................................................... 40
5、属性收集器 ............................................................................................................................... 40
5.1 PropertyCollector 介绍 ..................................................................................................... 41
5.1.1 数据检索 ................................................................................................................ 41
5.1.2 清单遍历和挑选对象 ........................................................................................... 41
5.2 属性收集相关的 vSphere 数据对象 ............................................................................... 42
5.3 属性收集相关的 vSphere 方法 ....................................................................................... 42
5.4 PropertyCollector 例程(RetrievePropertiesEx) ............................................................... 43
5.5 清单遍历 .......................................................................................................................... 52
5.5.1 TraversalSpec 遍历 ................................................................................................ 52
5.5.2 SelectionSpec 遍历 ............................................................................................... 62
5.5.3 客户端数据同步(WaitForUpdatesEx) .................................................................. 70
5.5.4 服务器数据传输 ................................................................................................... 72
5.5.5 PropertyCollector 性能 .......................................................................................... 72
5.5.6 SearchIndex ............................................................................................................ 73
6、认证和授权 ............................................................................................................................... 73
6.1 认证和授权管理的相关对象 .......................................................................................... 73
6.2 ESX/ESXi 和 vCenter Server 的认证和授权 ................................................................. 74
6.2.1 ESX/ESXi 用户模式 ............................................................................................ 75
6.2.2 vCenter Server 用户模式 ....................................................................................... 75
6.2.3 vSphere 安全模式 .................................................................................................. 76
6.3.4 建立用户,组和许可 ........................................................................................... 78
6.3 从 UserDirectory 获取用户和组信息 ............................................................................ 78
6.4 通过 HostLocalAccountManager 管理 ESX/ESXi 用户和组 ....................................... 79
6.5 通过 AuthorizationManager 管理角色和许可................................................................ 80
6.5.1 使用角色来统一权限设置 ................................................................................... 81
6.5.2 编辑例子角色来创建新的角色 ........................................................................... 82
6.5.3 通过许可来授予权限 Granting Privileges Through Permissions ........................ 83
6.6 通过 SessionManager 验证用户 .................................................................................... 85
6.7 使用证书库来自动登陆 .................................................................................................. 86
6.7.1 证书库方法 ........................................................................................................... 87
6.7.2 证书库备份文件 ................................................................................................... 87
6.7.3 证书库举例 ........................................................................................................... 88
6.7.4 使用证书库指定角色和用户 ............................................................................... 89
6.8 使用 LicenseManager 来管理许可证 ............................................................................ 89
7、主机........................................................................................................................................... 90
7.1 主机管理对象 .................................................................................................................. 91
7.2 检索主机信息 .................................................................................................................. 91
7.3 配置和重新配置主机 ...................................................................................................... 92
7.4 管理主机生命周期 .......................................................................................................... 93
3 / 241
Breeze.1978@aliyun.com
7.4.1 重启和关机 ............................................................................................................ 93
7.4.2 使用待机模式 ....................................................................................................... 93
7.4.3 断开连接和重新连接主机 ................................................................................... 94
7.4.4 查询和改变主机时间 ........................................................................................... 94
7.4.5 查询虚拟机内存的 Overhead .............................................................................. 95
8、存储........................................................................................................................................... 95
8.1 存储管理对象 .................................................................................................................. 95
8.2 存储介绍 .......................................................................................................................... 96
8.2.1 虚拟机如何访问存储 ........................................................................................... 97
8.2.2 数据存储 ............................................................................................................... 98
8.3 选择使用存储 API .......................................................................................................... 99
8.4 配置磁盘分区 ................................................................................................................ 100
8.5 多路径管理 .................................................................................................................... 101
8.6 配置 iSCSI 存储 ............................................................................................................ 102
8.7 创建和管理数据存储 .................................................................................................... 104
8.7.1 访问数据存储 ..................................................................................................... 105
8.7.2 创建和编辑一个 VMFS 数据存储 .................................................................... 106
8.7.3 移除和更新数据存储 ......................................................................................... 108
8.7.4 通过 HostStorageSystem 管理 VMFS 数据存储 ............................................... 108
8.8 管理 VMFS 卷拷贝(Resignaturing) .............................................................................. 109
8.9 管理诊断分区 ................................................................................................................ 110
8.9.1 检索诊断分区信息 ............................................................................................. 110
8.9.2 创建一个诊断分区 ............................................................................................. 111
8.10 代码示例 ...................................................................................................................... 111
9、网络......................................................................................................................................... 111
9.1 网络管理对象和方法 .................................................................................................... 111
9.2 网络介绍 ........................................................................................................................ 112
9.3 虚拟网络标准交换机环境 ............................................................................................ 113
9.3.1 虚拟交换机 ......................................................................................................... 113
9.3.2 端口组 ................................................................................................................. 113
9.3.3 虚拟机网络接口 ................................................................................................. 114
9.3.4 VMkernel 网络接口 ............................................................................................ 114
9.3.5 物理网络适配器(pnic) ....................................................................................... 115
9.4 使用 vSS 建立网络 ....................................................................................................... 115
9.4.1 检索网络配置信息 ............................................................................................. 115
9.4.2 添加一个虚拟交换机 ......................................................................................... 115
9.4.3 添加一个虚拟端口组 ......................................................................................... 116
9.4.4 添加一个 VMkernel 网络接口 .......................................................................... 117
9.5 定义主机网络策略 ........................................................................................................ 117
9.6 NIC Teaming ................................................................................................................... 118
9.7 建立 IPv6 网络 .............................................................................................................. 119
9.8 添加网络服务 ................................................................................................................. 120
9.8.1 添加一个 NTP 服务 ........................................................................................... 120
9.8.2 建立 IP 路由配置 ............................................................................................... 120
4 / 241
Breeze.1978@aliyun.com
9.8.3 建立 SNMP ......................................................................................................... 121
9.9 代码示例 ........................................................................................................................ 121
10、虚拟机配置 ........................................................................................................................... 122
10.1 虚拟机管理对象和方法 .............................................................................................. 122
10.2 创建虚拟机和虚拟机模板 .......................................................................................... 123
10.2.1 使用 VirtualMachineConfigSpec 来创建一个虚拟机 .................................... 123
10.2.2 创建虚拟机模板 ............................................................................................... 125
10.2.3 克隆一个虚拟机 ............................................................................................... 125
10.2.4 模板转换成虚拟机 ........................................................................................... 126
10.2.5 访问虚拟机信息 ............................................................................................... 126
10.3 配置虚拟机 .................................................................................................................. 128
10.3.1 名称和位置 ....................................................................................................... 128
10.3.2 硬件版本 ........................................................................................................... 128
10.3.3 启动选项 ........................................................................................................... 129
10.3.4 操作系统 ........................................................................................................... 129
10.3.5 CPU 和内存信息 ............................................................................................... 129
10.3.6 网络 ................................................................................................................... 131
10.3.7 光线通道 NPIV 设置 ....................................................................................... 131
10.3.8 文件位置 ........................................................................................................... 132
10.4 为虚拟机添加设备 ...................................................................................................... 132
10.5 执行虚拟机电源操作 .................................................................................................. 134
10.6 注册和注销虚拟机 ...................................................................................................... 135
10.7 自定义客户操作系统 .................................................................................................. 136
10.8 安装 VMware Tools ..................................................................................................... 137
10.9 虚拟机升级 .................................................................................................................. 137
11、虚拟机管理 ........................................................................................................................... 137
11.1 虚拟机迁移 .................................................................................................................. 138
11.1.1 冷迁移 ............................................................................................................... 138
11.1.2 使用 VMotion 迁移 .......................................................................................... 138
11.1.3 使用存储 VMotion ........................................................................................... 139
11.2 快照 .............................................................................................................................. 139
11.2.1 创建一个快照 ................................................................................................... 140
11.2.2 恢复到一个快照 ............................................................................................... 141
11.2.3 删除一个快照 ................................................................................................... 141
11.3 链接的虚拟机 .............................................................................................................. 141
11.3.1 链接的虚拟机和磁盘备份 ............................................................................... 141
11.3.2 创建一个链接的虚拟机 ................................................................................... 142
11.3.3 移除快照和删除链接虚拟机 ........................................................................... 144
11.3.4 在一个链接虚拟机群中迁移一个虚拟机 ....................................................... 145
11.3.5 提升一个虚拟机磁盘 ....................................................................................... 145
11.3.6 执行 Delta 磁盘的高级操作 ............................................................................ 146
12、虚拟应用 ............................................................................................................................... 147
12.1 关于虚拟应用 .............................................................................................................. 148
12.1.1 管理概述 ........................................................................................................... 148
5 / 241
Breeze.1978@aliyun.com
12.1.2 直接的和链接的子项 ....................................................................................... 148
12.1.3 OVF 包 ............................................................................................................... 149
12.2 创建一个 VirtualApp ................................................................................................... 150
12.3 管理 VirtualApp 子项 .................................................................................................. 150
12.4 导出一个虚拟应用 ...................................................................................................... 151
12.4.1 获得导出租约 ................................................................................................... 151
12.4.2 下载磁盘 ........................................................................................................... 151
12.4.3 产生 OVF 描述符 ............................................................................................ 152
12.4.4 完成租约 ........................................................................................................... 152
12.5 导入一个 OVF 包 ........................................................................................................ 152
12.6 虚拟应用生命周期 ...................................................................................................... 153
12.6.1 上电和下电一个虚拟应用 ............................................................................... 153
12.6.2 注销一个虚拟应用 ........................................................................................... 154
12.6.3 挂起一个虚拟应用 ........................................................................................... 154
12.6.4 销毁一个虚拟应用 ........................................................................................... 154
13、资源管理 ............................................................................................................................... 154
13.1 资源管理对象 .............................................................................................................. 155
13.2 资源管理介绍 .............................................................................................................. 155
13.3 资源分配 ...................................................................................................................... 156
13.3.1 资源池层次结构 ............................................................................................... 156
13.3.2 资源池管理指导原则 ....................................................................................... 157
13.3.3 群集概括 ........................................................................................................... 157
13.4 创建和配置资源池 ...................................................................................................... 158
13.4.1 了解扩展预留 ................................................................................................... 159
13.4.2 删除子资源池 ................................................................................................... 160
13.4.3 移动资源池或虚拟机到一个资源池中 ........................................................... 160
13.5 VMware DRS 和 VMware HA 群集介绍 .................................................................. 161
13.5.1 VMware DRS ..................................................................................................... 161
13.5.2 VMware HA ....................................................................................................... 162
13.6 创建和配置群集 .......................................................................................................... 162
13.6.1 创建一个群集 ................................................................................................... 162
13.6.2 添加一个主机到一个群集中 ........................................................................... 163
13.6.3 重新配置一个群集 ........................................................................................... 163
13.7 管理 DRS 群集 ............................................................................................................ 164
13.8 管理 HA 群集 .............................................................................................................. 164
13.8.1 首要和次要主机 ............................................................................................... 165
13.8.2 故障检测和主机网络隔离 ............................................................................... 165
13.8.3 同时使用 VMware HA 和 DRS ....................................................................... 166
14、任务和计划任务 ................................................................................................................... 166
14.1 创建任务 ...................................................................................................................... 166
14.1.1 Session 驻留 ...................................................................................................... 167
14.1.2 取消任务 ........................................................................................................... 167
14.1.3 使用 TaskInfo 决定任务状态 ............................................................................ 167
14.1.4 监视 TaskInfo 属性 ........................................................................................... 168
6 / 241
Breeze.1978@aliyun.com
14.2 访问和处理多任务 ...................................................................................................... 170
14.2.1 使用 ViewManager 对象收集数据 .................................................................. 170
14.2.2 使用一个 TaskManager 接口来收集数据 ........................................................ 181
14.2.3 了解 ScheduledTaskManager 接口.................................................................... 183
14.2.3.1.2 计划循环操作 ............................................................................................................. 185
14.2.4 使用 TaskHistoryCollector ............................................................................... 188
15、事件和警告 ........................................................................................................................... 189
15.1 事件和警告管理对象 .................................................................................................. 189
15.2 了解事件 ...................................................................................................................... 190
15.2.1 使用 EventManager 管理事件 ......................................................................... 190
15.2.2 事件数据对象 ................................................................................................... 191
15.2.3 设计事件信息内容格式 ................................................................................... 192
15.2.4 创建自定义事件 ............................................................................................... 192
15.3 使用 EventHistoryCollector ......................................................................................... 193
15.3.1 创建一个 EventHistoryCollector 过滤器 ......................................................... 194
15.3.2 管理 HistoryCollector ....................................................................................... 194
15.4 使用警告 ...................................................................................................................... 194
15.4.1 获取警告列表 ................................................................................................... 195
15.4.2 创建警告 ........................................................................................................... 195
15.5 使用 AlarmSpec 数据对象定义警告 .......................................................................... 196
15.5.1 使用 AlarmExpression 指定警告触发条件 ...................................................... 197
15.5.2 指定警告动作 ................................................................................................... 198
15.6 删除或禁用一个警告 .................................................................................................. 199
16、vSphere 性能 ........................................................................................................................ 199
16.1 vSphere 性能数据收集 ................................................................................................. 200
16.2 PerformanceManager 对象和方法 ............................................................................... 201
16.3 检索 vSphere 性能数据 ............................................................................................... 203
16.3.1 性能计数器例程(QueryPerf)............................................................................ 204
16.3.2 大规模的性能数据检索 ................................................................................... 214
16.3.3 使用 QueryPerf 方法作为原始数据 ................................................................ 215
16.3.4 查询方法比较 ................................................................................................... 215
16.3.5 检索总计性性能数据 ....................................................................................... 216
16.4 性能计数器元数据 ...................................................................................................... 216
16.5 性能时间间隔 .............................................................................................................. 217
16.5.1 ESXi 服务器性能时间间隔 .............................................................................. 218
16.5.2 vCenter 服务器性能时间间隔 .......................................................................... 218
16.6 vSphere 性能和数据存储 ............................................................................................. 219
16.6.1 编辑历史时间间隔 ........................................................................................... 219
16.6.2 编辑性能计数器收集级别 ............................................................................... 220
17、诊断和处理故障 ................................................................................................................... 221
17.1 处理故障最佳实践 ...................................................................................................... 221
17.2 配置文件和日志文件概述 .......................................................................................... 222
17.2.1 ESX/ESXi 日志文件 ......................................................................................... 223
17.2.2 虚拟机日志文件 ............................................................................................... 224
7 / 241
Breeze.1978@aliyun.com
17.2.3 vCenter 服务器日志 .......................................................................................... 225
17.3 编辑日志级别来获得详细的信息 .............................................................................. 225
17.3.1 在 ESX/ESXi 系统上设置日志级别 ................................................................ 226
17.3.2 产生日志 ........................................................................................................... 227
17.3.3 在 vCenter 服务器系统上设置日志级别 ........................................................ 227
17.4 使用 DianosticManager ............................................................................................... 228
17.5 使用 MOB 来查看 DiagnosticManager ...................................................................... 229
17.6 产生诊断包 .................................................................................................................. 230
18、Managed 对象浏览 ............................................................................................................... 231
18.1 使用 MOB 来查看对象模型 ....................................................................................... 231
18.1.1 访问 MOB .......................................................................................................... 231
18.1.2 使用 MOB 导航 VMware 架构对象模型 ........................................................ 232
18.2 使用 MOB 来调用方法 ............................................................................................... 232
18.2.1 传入原始的数据类型给方法 ........................................................................... 233
18.2.2 传入原始数据队列给方法 ............................................................................... 233
18.2.3 传入复合结构给方法 ....................................................................................... 233
19、HTTP 访问 vSphere 服务器文件 ......................................................................................... 237
19.1 HTTP 访问介绍 ............................................................................................................ 237
19.2 HTTP 访问的 URL 语法 .............................................................................................. 238
19.2.1 数据存储访问(/folder) ..................................................................................... 238
19.2.2 主机文件访问(/host) ........................................................................................ 239
19.2.3 更新包访问(/tmp) ............................................................................................. 240
19.2.4 HTTP 访问权限需求 ......................................................................................... 240
20、权限参考 ............................................................................................................................... 241
20.1 调用操作所需的权限 .................................................................................................. 241
8 / 241