community.vmware.vmware_object_rename – Renames VMware objects¶
Note
This plugin is part of the community.vmware collection (version 1.9.0).
To install it use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_object_rename
.
Synopsis¶
This module can be used to rename VMware objects.
All variables and VMware object names are case sensitive.
Renaming Host and Network is not supported by VMware APIs.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7
PyVmomi
vSphere Automation SDK
Parameters¶
Examples¶
- 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Abhijeet Kasurde (@Akasurde)