Knife vSphere 使用与安装指南

1. 安装指南

Knife vSphere 是作为 Chef Workstation 的一部分发布的，因此最简单的方式是安装 Chef Workstation。如果你正在使用 bundler 作为项目的一部分，可以将 knife 和 knife-vSphere 添加到你的 Gemfile 中：

gem 'knife'
gem 'knife-vSphere'

根据你的系统配置，你可能需要以 root 权限运行这个命令。

2. 项目使用说明

Knife vSphere 是一个 Chef Knife 插件，用于与 VMware vSphere 进行交互。该插件目前支持以下功能：

列表：

• 虚拟机 (VMs)
• 文件夹
• 模板
• 数据存储
• VLANs（需要分布式交换机）
• 资源池和集群
• 自定义规范
• 池或集群中的主机
• VM 的网络卡和 VLAN

虚拟机操作：

• 开机/关机
• 克隆（可选的 chef 引导和运行列表）
• 删除
• 添加 VMDK
• 迁移
• 添加网络
• 连接/断开网络
• 删除网络
• 更改网络
• 启用 VNC 远程控制台

克隆特定的自定义选项（对于 Linux 客户机）：

• 目标文件夹
• CPU 核心数
• 每个插槽的 CPU 核心数
• 内存大小
• 内存预留
• DNS 设置
• 主机名/域名
• IP 地址/默认网关
• VLAN（需要分布式交换机）
• 数据存储
• 资源池

注意：对于 Windows 客户机，我们可以运行 FIELDS。

3. 项目API使用文档

以下是 knife-vSphere 的一些基本使用示例，帮助你入门。

• 从 VMware 模板克隆并引导 chef。

$ knife vsphere vm clone MACHINENAME --template TEMPLATENAME --bootstrap --cips dhcp

• 从 VMware 模板克隆 VM，并使用自定义引导。

$ knife vsphere vm clone MACHINENAME --template TEMPLATENAME --bootstrap --cips dhcp \
  --cspec SPEC --connection-user USER --connection-password PASSWORD

如果你将模板放在了除根文件夹之外的位置，可以添加 -f FOLDERNAME 参数，如果你想将 VM 创建在特定的文件夹中，可以使用 --dest-folder FOLDERNAME。

• 列出可用的 VMware 模板。

$ knife vsphere template list

• 删除虚拟机。

$ knife vsphere vm delete MACHINENAME (-P 将从 chef 服务器中移除)

4. 项目安装方式

该插件提供的 Knife 子命令如下。具体的命令选项可以通过调用子命令并带上 --help 标志来查看。

knife vsphere vm list

枚举目标数据中心的虚拟机。当前只显示名称。

-r, --recursive    - 递归地通过子文件夹到指定文件夹
--only-folders     - 只打印文件夹名称。意味着递归

knife vsphere vm find

根据条件搜索虚拟机并显示选定字段。

--match-ip IP                匹配 IP
--match-name VMNAME          匹配名称
--match-os OS                匹配操作系统
--match-tools TOOLSSTATE     匹配工具状态
--powered-off                只显示已停止的机器
--powered-on                 只显示已启动的机器

字段：

--alarms                     显示警报状态
--cpu                        显示 CPU
--cpu-hot-add-enabled        显示 CPU 热添加启用标志
--esx-disk                   显示 ESX 磁盘
--full-path                  显示 VM 的完整路径
--short-path                 显示包含文件夹名称
--hostname                   显示主机名
--host_name                  显示 VM 主机名称
--ip                         显示主 IP
--networks                   显示所有网络和 IPs
--os                         显示操作系统详细信息
--os-disks                   显示操作系统磁盘
--ram                        显示内存
--memory-hot-add-enabled     显示内存热添加启用标志
--snapshots                  显示快照
--tools                      显示工具状态

示例：

$ knife vsphere vm find --snapshots --full-path --cpu --ram --esx-disk \
    --os-disk --os --match-name my_machine_1 --alarms --tools --ip --ips \
    --match-ip 123 --match-tools toolsOk

knife vsphere vm state VMNAME

管理虚拟机的电源状态，即开关机。

-s STATE, --state STATE    - 将 VM 转换为指定的电源状态；可以是 on|off|suspend|reboot
-w PORT, --wait-port PORT  - 等待 VM 在端口上可访问
-g, --shutdown             - 客户端 OS 关机（格式：-s off -g）
-r, --recursive            - 递归地通过子文件夹到指定文件夹以找到 VM

knife vsphere pool list

枚举目标数据中心的资源池和集群。

knife vsphere template list

枚举目标数据中心的 VM 模板。当前只显示名称。

-f FOLDER       - 在指定文件夹内查找，默认是根文件夹

knife vsphere customization list

枚举目标数据中心的自定义规范。当前只显示名称。

knife vsphere vm clone

从现有的 VM 模板克隆新的 VM 实例，可选地应用现有的自定义规范。如果指定了自定义参数，如 --chost 和 --cdomain，或者考虑了从 vSphere 获取的自定义规范，将尝试默认的自定义规范。

• 对于 Windows，将尝试基于 sysprep 的无人值守自定义，以工作组成员模式运行（除非另外指定，VM 名称为主机名）。
• 对于 Linux，将使用 VM 名称作为主机名的固定名称自定义。

此命令有许多选项来自定义你的 VM。最重要的是初始模板。我们有一些关于如何制作克隆模板的指导：如何制作克隆模板。

Chef 引导选项

这些选项改变了 VM 创建后引导到 Chef 的方式。至少需要 --bootstrap 来进行引导。