community.vmware.vmware_object_rename 模块 – 重命名 VMware 对象

注意

此模块是 community.vmware 集合（版本 5.2.0）的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.vmware。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 Playbook 中使用它，请指定：community.vmware.vmware_object_rename。

概要

  • 此模块可用于重命名 VMware 对象。

  • VMware API 不支持重命名主机和网络。

要求

执行此模块的主机需要满足以下要求。

  • vSphere Automation SDK

参数

参数

注释

hostname

string

vSphere vCenter 服务器的主机名或 IP 地址。

如果未在任务中指定该值，则将改用环境变量 VMWARE_HOST 的值。

new_name

别名：object_new_name

string / 必选

VMware 对象的新名称。

object_moid

string

要使用的 VMware 对象的托管对象 ID。

与 object_name 互斥。

object_name

string

要使用的对象的名称。

与 object_moid 互斥。

object_type

string / 必选

要使用的对象的类型。

有效选项包括 Cluster、ClusterComputeResource、Datacenter、Datastore、Folder、ResourcePool、VM 或 VirtualMachine。

选择

  • "ClusterComputeResource"

  • "Cluster"

  • "Datacenter"

  • "Datastore"

  • "Folder"

  • "Network"

  • "ResourcePool"

  • "VM"

  • "VirtualMachine"

password

别名：pass, pwd

string

vSphere vCenter 服务器的密码。

如果未在任务中指定该值，则将改用环境变量 VMWARE_PASSWORD 的值。

port

integer

vSphere vCenter 的端口号。

如果未在任务中指定该值，则将改用环境变量 VMWARE_PORT 的值。

默认值： 443

protocol

string

连接到协议。

选择

  • "http"

  • "https" ← (默认)

proxy_host

string

将接收所有 HTTPS 请求并转发它们的代理的地址。

格式是主机名或 IP。

如果未在任务中指定该值，则将改用环境变量 VMWARE_PROXY_HOST 的值。

proxy_port

integer

将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。

如果未在任务中指定该值，则将改用环境变量 VMWARE_PROXY_PORT 的值。

username

别名：admin, user

string

vSphere vCenter 服务器的用户名。

如果未在任务中指定该值，则将改用环境变量 VMWARE_USER 的值。

validate_certs

boolean

当 SSL 证书无效时允许连接。

当证书不受信任时，设置为 false。

如果未在任务中指定该值，则将改用环境变量 VMWARE_VALIDATE_CERTS 的值。

选择

  • false

  • true ← (默认)

说明

注意

  • 所有模块都需要 API 写入权限，因此在免费的 ESXi 许可证上不支持。

  • 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Rename a virtual machine
  community.vmware.vmware_object_rename:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    new_name: Fedora_31
    object_name: Fedora_VM
    object_type: VirtualMachine
  delegate_to: localhost

- name: Rename a virtual machine using moid
  community.vmware.vmware_object_rename:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    new_name: Fedora_31
    object_moid: vm-14
    object_type: VirtualMachine
  delegate_to: localhost

- name: Rename a datacenter
  community.vmware.vmware_object_rename:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    new_name: Asia_Datacenter
    object_name: dc1
    object_type: Datacenter
  delegate_to: localhost

- name: Rename a folder with moid
  community.vmware.vmware_object_rename:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    new_name: backup
    object_moid: group-v46
    object_type: Folder
  delegate_to: localhost

- name: Rename a cluster with moid
  community.vmware.vmware_object_rename:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    new_name: CCR_1
    object_moid: domain-c33
    object_type: Cluster
  delegate_to: localhost

返回值

常见的返回值记录在此处，以下是此模块特有的字段

键

描述

rename_status

字典

关于 VMware 对象重命名操作的元数据

返回: 成功时

示例: {"current_name": "Fedora_31", "desired_name": "Fedora_31", "previous_name": "Fedora_VM"}

作者

  • Abhijeet Kasurde (@Akasurde)