VMware vCloud Director Ansible模块使用指南

环境配置

在使用vCloud Director Ansible模块前，需要先配置环境变量或本地变量来连接vCloud Director实例。

登录方式

模块支持两种登录方式：

1. 环境变量方式 - 通过设置环境变量来配置登录信息，所有后续操作都会自动使用这些变量：

- name: vCloudDirectorAnsible
  hosts: localhost
  environment:
    env_user: VCD_USER_NAME
    env_password: VCD_USER_PASSWORD
    env_host: VCD_URL            # VCD实例URL
    env_org: VCD_ORG             # 登录的VCD组织
    env_api_version: PYVCLOUD_API_VERSION
    env_verify_ssl_certs: false

2. 本地变量方式 - 为特定模块设置登录变量，这种方式可以针对不同模块使用不同的vCloud Director实例。

注意：本地变量的优先级高于环境变量。

响应格式

所有操作都会返回统一的响应格式，至少包含以下属性：

• msg - 操作成功或失败的描述信息
• changed - 布尔值，表示基础设施是否被修改

目录(Catalog)管理

目录状态管理

创建目录

- name: 创建目录
  vcd_catalog:
    catalog_name: "测试目录"
    description: "测试描述"
    state: "present"

参数说明：

• catalog_name - (必填) 目录名称
• description - (必填) 目录描述
• state - 必须设为"present"表示创建操作

更新目录

- name: 更新目录
  vcd_catalog:
    catalog_name: "测试目录"
    new_catalog_name: "新测试目录"
    description: "新描述"
    state: "update"

参数说明：

• new_catalog_name - 新目录名称
• 其他参数与创建相同

删除目录

- name: 删除目录
  vcd_catalog:
    catalog_name: "测试目录"
    state: "absent"

目录操作

共享/取消共享目录

- name: 共享目录
  vcd_catalog:
    catalog_name: "测试目录"
    shared: "true"
    operation: "shared"

参数说明：

• shared - true表示共享，false表示取消共享
• operation - 必须设为"shared"

列出目录项

- name: 列出目录项
  vcd_catalog:
    catalog_name: "测试目录"
    operation: "list_items"

目录项(Catalog Item)管理

目录项状态管理

上传媒体/OVA文件

- name: 上传媒体文件
  vcd_catalog_item:
    catalog_name: "测试目录"
    item_name: "测试媒体"
    file_name: "test.iso"
    chunk_size: 1048576
    state: "present"

参数说明：

• item_name - 目录项名称
• file_name - 文件路径
• chunk_size - 分块上传大小(字节)

删除目录项

- name: 删除目录项
  vcd_catalog_item:
    catalog_name: "测试目录"
    item_name: "测试媒体"
    state: "absent"

目录项操作

捕获vApp为模板

- name: 捕获vApp
  vcd_catalog_item:
    catalog_name: "测试目录"
    item_name: "测试模板"
    vapp_name: "测试vApp"
    vdc_name: "测试VDC"
    operation: "capturevapp"

参数说明：

• vapp_name - 要捕获的vApp名称
• vdc_name - VDC名称
• customize_on_instantiate - 是否允许实例化时自定义

列出目录项中的虚拟机

- name: 列出虚拟机
  vcd_catalog_item:
    catalog_name: "测试目录"
    item_name: "测试模板"
    operation: "list_vms"

vApp管理

vApp状态管理

创建vApp

- name: 创建vApp
  vcd_vapp:
    vapp_name: "测试vApp"
    template_name: "测试模板"
    catalog_name: "测试目录"
    vdc: "测试VDC"
    network: "测试网络"
    fence_mode: "bridged"
    ip_allocation_mode: 'dhcp'
    state: "present"

关键参数：

• fence_mode - 网络隔离模式(bridged或nat)
• ip_allocation_mode - IP分配模式(dhcp/pool/manual)
• deploy - 是否立即部署
• power_on - 是否立即开机

删除vApp

- name: 删除vApp
  vcd_vapp:
    vapp_name: "测试vApp"
    vdc: "测试VDC"
    force: true
    state: "absent"

vApp操作

电源管理

- name: 开机vApp
  vcd_vapp:
    vapp_name: "测试vApp"
    vdc: "测试VDC"
    operation: "poweron"

- name: 关机vApp
  vcd_vapp:
    vapp_name: "测试vApp"
    vdc: "测试VDC"
    operation: "poweroff"

部署管理

- name: 部署vApp
  vcd_vapp:
    vapp_name: "测试vApp"
    vdc: "测试VDC"
    operation: "deploy"

- name: 取消部署vApp
  vcd_vapp:
    vapp_name: "测试vApp"
    vdc: "测试VDC"
    operation: "undeploy"

最佳实践

1. 变量管理：建议使用Ansible Vault保护敏感信息如密码
2. 幂等性：所有操作都设计为幂等的，可以安全地重复执行
3. 错误处理：检查返回的changed和msg字段确认操作结果
4. 性能优化：大文件上传时适当调整chunk_size参数

通过这套Ansible模块，可以实现vCloud Director资源的全生命周期自动化管理，显著提升云环境运维效率。